basics

2025-09-15 13:13:41 -07:00 · 2025-09-15 13:13:41 -07:00 · 931bb597f4
commit 931bb597f4
parent 998b8ccb25
10 changed files with 357 additions and 0 deletions
--- a/.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc
+++ b/.cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc
@ -0,0 +1 @@
+../../CLAUDE.md
--- a/.gitignore
+++ b/.gitignore
@ -0,0 +1,34 @@
+# dependencies (bun install)
+node_modules
+
+# output
+out
+dist
+*.tgz
+
+# code coverage
+coverage
+*.lcov
+
+# logs
+logs
+_.log
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# caches
+.eslintcache
+.cache
+*.tsbuildinfo
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
--- a/CLAUDE.md
+++ b/CLAUDE.md
@ -0,0 +1,111 @@
+---
+description: Use Bun instead of Node.js, npm, pnpm, or vite.
+globs: "*.ts, *.tsx, *.html, *.css, *.js, *.jsx, package.json"
+alwaysApply: false
+---
+
+Default to using Bun instead of Node.js.
+
+- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
+- Use `bun test` instead of `jest` or `vitest`
+- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
+- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
+- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
+- Bun automatically loads .env, so don't use dotenv.
+
+## APIs
+
+- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
+- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
+- `Bun.redis` for Redis. Don't use `ioredis`.
+- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
+- `WebSocket` is built-in. Don't use `ws`.
+- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
+- Bun.$`ls` instead of execa.
+
+## Testing
+
+Use `bun test` to run tests.
+
+```ts#index.test.ts
+import { test, expect } from "bun:test";
+
+test("hello world", () => {
+  expect(1).toBe(1);
+});
+```
+
+## Frontend
+
+Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
+
+Server:
+
+```ts#index.ts
+import index from "./index.html"
+
+Bun.serve({
+  routes: {
+    "/": index,
+    "/api/users/:id": {
+      GET: (req) => {
+        return new Response(JSON.stringify({ id: req.params.id }));
+      },
+    },
+  },
+  // optional websocket support
+  websocket: {
+    open: (ws) => {
+      ws.send("Hello, world!");
+    },
+    message: (ws, message) => {
+      ws.send(message);
+    },
+    close: (ws) => {
+      // handle close
+    }
+  },
+  development: {
+    hmr: true,
+    console: true,
+  }
+})
+```
+
+HTML 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.
+
+```html#index.html
+<html>
+  <body>
+    <h1>Hello, world!</h1>
+    <script type="module" src="./frontend.tsx"></script>
+  </body>
+</html>
+```
+
+With the following `frontend.tsx`:
+
+```tsx#frontend.tsx
+import React from "react";
+
+// import .css files directly and it works
+import './index.css';
+
+import { createRoot } from "react-dom/client";
+
+const root = createRoot(document.body);
+
+export default function Frontend() {
+  return <h1>Hello, world!</h1>;
+}
+
+root.render(<Frontend />);
+```
+
+Then, run index.ts
+
+```sh
+bun --hot ./index.ts
+```
+
+For more information, read the Bun API docs in `node_modules/bun-types/docs/**.md`.
--- a/bun.lock
+++ b/bun.lock
@ -0,0 +1,37 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "pluto",
+      "dependencies": {
+        "hono": "^4.9.7",
+        "kleur": "^4.1.5",
+      },
+      "devDependencies": {
+        "@types/bun": "latest",
+      },
+      "peerDependencies": {
+        "typescript": "^5",
+      },
+    },
+  },
+  "packages": {
+    "@types/bun": ["@types/bun@1.2.22", "", { "dependencies": { "bun-types": "1.2.22" } }, "sha512-5A/KrKos2ZcN0c6ljRSOa1fYIyCKhZfIVYeuyb4snnvomnpFqC0tTsEkdqNxbAgExV384OETQ//WAjl3XbYqQA=="],
+
+    "@types/node": ["@types/node@24.5.0", "", { "dependencies": { "undici-types": "~7.12.0" } }, "sha512-y1dMvuvJspJiPSDZUQ+WMBvF7dpnEqN4x9DDC9ie5Fs/HUZJA3wFp7EhHoVaKX/iI0cRoECV8X2jL8zi0xrHCg=="],
+
+    "@types/react": ["@types/react@19.1.13", "", { "dependencies": { "csstype": "^3.0.2" } }, "sha512-hHkbU/eoO3EG5/MZkuFSKmYqPbSVk5byPFa3e7y/8TybHiLMACgI8seVYlicwk7H5K/rI2px9xrQp/C+AUDTiQ=="],
+
+    "bun-types": ["bun-types@1.2.22", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-hwaAu8tct/Zn6Zft4U9BsZcXkYomzpHJX28ofvx7k0Zz2HNz54n1n+tDgxoWFGB4PcFvJXJQloPhaV2eP3Q6EA=="],
+
+    "csstype": ["csstype@3.1.3", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="],
+
+    "hono": ["hono@4.9.7", "", {}, "sha512-t4Te6ERzIaC48W3x4hJmBwgNlLhmiEdEE5ViYb02ffw4ignHNHa5IBtPjmbKstmtKa8X6C35iWwK4HaqvrzG9w=="],
+
+    "kleur": ["kleur@4.1.5", "", {}, "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ=="],
+
+    "typescript": ["typescript@5.9.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A=="],
+
+    "undici-types": ["undici-types@7.12.0", "", {}, "sha512-goOacqME2GYyOZZfb5Lgtu+1IDmAlAEu5xnD3+xTzS10hT0vzpf0SPjkXwAw9Jm+4n/mQGDP3LO8CPbYROeBfQ=="],
+  }
+}
--- a/package.json
+++ b/package.json
@ -0,0 +1,20 @@
+{
+  "name": "pluto",
+  "module": "index.ts",
+  "type": "module",
+  "private": true,
+  "scripts": {
+    "start": "bun src/server.ts",
+    "dev": "bun --hot src/server.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "hono": "^4.9.7",
+    "kleur": "^4.1.5"
+  }
+}
--- a/public/img/.gitignore
+++ b/public/img/.gitignore
--- a/public/vendor/.gitignore
+++ b/public/vendor/.gitignore
--- a/src/server.ts
+++ b/src/server.ts
@ -0,0 +1,78 @@
+import { Hono } from "hono"
+import { serveStatic } from "hono/bun"
+import { prettyJSON } from "hono/pretty-json"
+import color from "kleur"
+
+import { transpile, isFile } from "./utils"
+
+export const NOSE_ICON = ` ͡° ͜ʖ ͡°`
+
+//
+// Hono setup
+//
+
+const app = new Hono()
+
+app.use("*", prettyJSON())
+
+app.use('/img/*', serveStatic({ root: './public' }))
+app.use('/vendor/*', serveStatic({ root: './public' }))
+app.use('/css/*', serveStatic({ root: './src' }))
+
+app.use("*", async (c, next) => {
+    const start = Date.now()
+    await next()
+    const end = Date.now()
+    const fn = c.res.status < 300 ? color.green : c.res.status < 500 ? color.yellow : color.red
+    console.log(fn(`${c.res.status} ${c.req.method} ${c.req.url} (${end - start}ms)`))
+})
+
+app.get("/js/:path{.+}", async c => {
+    const path = "./src/js/" + c.req.param("path")
+    const ts = path.replace(".js", ".ts")
+    if (isFile(ts)) {
+        return new Response(await transpile(ts), { headers: { "Content-Type": "text/javascript" } })
+    } else if (isFile(path)) {
+        return new Response(Bun.file(path), { headers: { "Content-Type": "text/javascript" } })
+    } else {
+        return c.text("File not found", 404)
+    }
+})
+
+//
+// app routes
+//
+
+
+
+//
+// server shutdown
+//
+
+// @ts-ignore
+globalThis.__nose_cleanup?.()
+
+// @ts-ignore
+globalThis.__nose_cleanup = () => {
+}
+
+for (const sig of ["SIGINT", "SIGTERM"] as const) {
+    process.on(sig, () => {
+        // @ts-ignore
+        globalThis.__nose_cleanup?.()
+        process.exit()
+    })
+}
+
+
+//
+// server start
+//
+
+console.log(color.cyan(NOSE_ICON))
+
+export default {
+    port: process.env.PORT || 3000,
+    fetch: app.fetch,
+    idleTimeout: 0,
+}
--- a/src/utils.tsx
+++ b/src/utils.tsx
@ -0,0 +1,47 @@
+import { statSync } from "node:fs"
+import { stat } from "node:fs/promises"
+
+// Is the given `path` a file?
+export function isFile(path: string): boolean {
+    try {
+        const stats = statSync(path)
+        return stats.isFile()
+    } catch {
+        return false
+    }
+}
+
+// Is the given `path` a directory?
+export function isDir(path: string): boolean {
+    try {
+        const stats = statSync(path)
+        return stats.isDirectory()
+    } catch {
+        return false
+    }
+}
+
+// Generate a random 8 character string
+export function randomID(): string {
+    return Math.random().toString(36).slice(2, 10)
+}
+
+
+const transpiler = new Bun.Transpiler({ loader: 'tsx' })
+const transpileCache: Record<string, string> = {}
+
+// Transpile the frontend *.ts file at `path` to JavaScript.
+export async function transpile(path: string): Promise<string> {
+    const code = await Bun.file(path).text()
+
+    const { mtime } = await stat(path)
+    const key = `${path}?${mtime}`
+
+    let cached = transpileCache[key]
+    if (!cached) {
+        cached = transpiler.transformSync(code)
+        transpileCache[key] = cached
+    }
+
+    return cached
+}
--- a/tsconfig.json
+++ b/tsconfig.json
@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}