docs: 同步 AGENTS.md 至 Drizzle v1 beta 并添加开发原则
- 所有 AGENTS.md 新增「开发原则」:不向后兼容、改代码必须同步文档、前向迁移 - 根 AGENTS.md: 更新 Database 段落为 Drizzle v1 beta + postgres-js + RQBv2 - server AGENTS.md: 更新 tech stack、目录结构、ORPC 示例、数据库段落 - drizzle-zod → drizzle-orm/zod - bun-sql → postgres-js - RQBv1 回调 → RQBv2 对象语法 - 新增 relations.ts 和 DB instance 示例 - desktop AGENTS.md: 添加开发原则和文档同步规则
This commit is contained in:
18
AGENTS.md
18
AGENTS.md
@@ -120,7 +120,13 @@ import type { ReactNode } from 'react'
|
||||
- ORPC: Use `ORPCError` with proper codes (`NOT_FOUND`, `INPUT_VALIDATION_FAILED`)
|
||||
- Never use empty catch blocks
|
||||
|
||||
## Database (Drizzle ORM)
|
||||
## Database (Drizzle ORM v1 beta + postgres-js)
|
||||
|
||||
- **ORM**: Drizzle ORM `1.0.0-beta` (RQBv2)
|
||||
- **Driver**: `drizzle-orm/postgres-js` (NOT `bun-sql`)
|
||||
- **Validation**: `drizzle-orm/zod` (built-in, NOT separate `drizzle-zod` package)
|
||||
- **Relations**: Defined via `defineRelations()` in `src/server/db/relations.ts`
|
||||
- **Query style**: RQBv2 object syntax (`orderBy: { createdAt: 'desc' }`, `where: { id: 1 }`)
|
||||
|
||||
```typescript
|
||||
export const myTable = pgTable('my_table', {
|
||||
@@ -143,6 +149,14 @@ export const myTable = pgTable('my_table', {
|
||||
- Workspace packages use `"catalog:"` — never hardcode versions
|
||||
- Internal packages use `"workspace:*"` references
|
||||
|
||||
## Development Principles
|
||||
|
||||
> **These principles apply to ALL code changes. Agents MUST follow them on every task.**
|
||||
|
||||
1. **No backward compatibility** — This project is in rapid iteration. Always use the latest API and patterns. Never keep deprecated code paths or old API fallbacks "just in case".
|
||||
2. **Always sync documentation** — When code changes, immediately update all related documentation (`AGENTS.md`, `README.md`, inline code examples). Code and docs must never drift apart. This includes updating code snippets in docs when imports, APIs, or patterns change.
|
||||
3. **Forward-only migration** — When upgrading dependencies, fully adopt the new API. Don't mix old and new patterns in the same codebase.
|
||||
|
||||
## Critical Rules
|
||||
|
||||
**DO:**
|
||||
@@ -150,6 +164,7 @@ export const myTable = pgTable('my_table', {
|
||||
- Use `@/*` path aliases (not relative imports)
|
||||
- Include `createdAt`/`updatedAt` on all tables
|
||||
- Use `catalog:` for dependency versions
|
||||
- Update `AGENTS.md` and other docs whenever code patterns change
|
||||
|
||||
**DON'T:**
|
||||
- Use `npm`, `npx`, `node`, `yarn`, `pnpm` — always use `bun` / `bunx`
|
||||
@@ -158,6 +173,7 @@ export const myTable = pgTable('my_table', {
|
||||
- Commit `.env` files
|
||||
- Use empty catch blocks `catch(e) {}`
|
||||
- Hardcode dependency versions in workspace packages
|
||||
- Leave docs out of sync with code changes
|
||||
|
||||
## Git Workflow
|
||||
|
||||
|
||||
Reference in New Issue
Block a user