git.iko.soy/rowtype-yoga/purescript-abcjs
on main help sign in
rowtype-yoga/purescript-abcjs/CLAUDE.md
111 lines 2.6 kB history raw
1---
2description: Use Bun instead of Node.js, npm, pnpm, or vite.
3globs: "*.ts, *.tsx, *.html, *.css, *.js, *.jsx, package.json"
4alwaysApply: false
5---
7Default to using Bun instead of Node.js.
9- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
10- Use `bun test` instead of `jest` or `vitest`
11- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
12- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
13- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
14- Bun automatically loads .env, so don't use dotenv.
16## APIs
18- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
19- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
20- `Bun.redis` for Redis. Don't use `ioredis`.
21- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
22- `WebSocket` is built-in. Don't use `ws`.
23- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
24- Bun.$`ls` instead of execa.
26## Testing
28Use `bun test` to run tests.
30```ts#index.test.ts
31import { test, expect } from "bun:test";
33test("hello world", () => {
34 expect(1).toBe(1);
35});
36```
38## Frontend
40Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
42Server:
44```ts#index.ts
45import index from "./index.html"
47Bun.serve({
48 routes: {
49 "/": index,
50 "/api/users/:id": {
51 GET: (req) => {
52 return new Response(JSON.stringify({ id: req.params.id }));
53 },
54 },
55 },
56 // optional websocket support
57 websocket: {
58 open: (ws) => {
59 ws.send("Hello, world!");
60 },
61 message: (ws, message) => {
62 ws.send(message);
63 },
64 close: (ws) => {
65 // handle close
66 }
67 },
68 development: {
69 hmr: true,
70 console: true,
71 }
72})
73```
75HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
77```html#index.html
78<html>
79 <body>
80 <h1>Hello, world!</h1>
81 <script type="module" src="./frontend.tsx"></script>
82 </body>
83</html>
84```
86With the following `frontend.tsx`:
88```tsx#frontend.tsx
89import React from "react";
91// import .css files directly and it works
92import './index.css';
94import { createRoot } from "react-dom/client";
96const root = createRoot(document.body);
98export default function Frontend() {
99 return <h1>Hello, world!</h1>;
102root.render(<Frontend />);
103```
105Then, run index.ts
107```sh
108bun --hot ./index.ts
109```
111For more information, read the Bun API docs in `node_modules/bun-types/docs/**.md`.