Skip to content

AGENTS.md

Latest commit

 

History

History
131 lines (100 loc) · 3.46 KB

AGENTS.md

File metadata and controls

131 lines (100 loc) · 3.46 KB

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>
  • Use bunx <package> <command> instead of npx <package> <command>
  • 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.

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:

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>
  <body>
    <h1>Hello, world!</h1>
    <script type="module" src="./frontend.tsx"></script>
  </body>
</html>

With the following frontend.tsx:

import React from "react";
import { createRoot } from "react-dom/client";

// import .css files directly and it works
import './index.css';

const root = createRoot(document.body);

export default function Frontend() {
  return <h1>Hello, world!</h1>;
}

root.render(<Frontend />);

Then, run index.ts

bun --hot ./index.ts

For more information, read the Bun API docs in node_modules/bun-types/docs/**.mdx.

dbcli 開發模式

本專案開發時 dbcli 尚未安裝到 PATH，使用 bun run src/cli.ts 替代 dbcli：

bun run src/cli.ts list
bun run src/cli.ts schema users --format json
bun run src/cli.ts query "SELECT * FROM users LIMIT 10" --format json

dbcli 使用規範

操作資料庫前，必須依序執行：

  1. bun run src/cli.ts blacklist list — 確認敏感資料已受保護
  2. bun run src/cli.ts schema <table> --format json — 確認目標表的真實欄位名稱
  3. 再執行 query / insert / update / export 等操作

嚴禁猜測欄位名。 務必先用 schema 確認。

注意事項：

  • 優先使用 --format json
  • 寫入前用 --dry-run 預覽 SQL
  • query-only 模式會自動加 LIMIT 1000，查 information_schema 時加 --no-limit
  • 技能來源：assets/SKILL.md（精簡工作流與表格式總覽）與 assets/reference.md（完整子命令、旗標與範例），dbcli skill --install <platform> 會兩者一併寫入對應目錄