forked from imbytecat/fullstack-starter
imbytecat
8ceb212033
- 更新依赖管理文档，明确使用 Bun Catalog 统一管理版本并规范安装方式，新增已知问题与解决方案、依赖选择经验及 Git 工作流要求，强化团队协作与技术决策可追溯性。 - 添加硬件指纹页面，展示机器码、指纹质量等级及详细信息，并支持一键复制和缓存提示。 - 添加指纹路由配置并更新路由树类型定义以包含新路由路径和相关类型。 - 添加硬件指纹获取接口的契约定义，包含指纹字符串、质量等级、强标识符数量和时间戳的验证规则。 - 添加指纹合约到API合约导出中 - 添加硬件指纹获取接口，支持10分钟缓存并包含主硬盘序列号以提升指纹稳定性。 - 添加指纹路由到API路由器中 - 重构硬件指纹生成逻辑，引入缓存机制、质量等级评估和容错处理，提升稳定性与可维护性。
371 lines
11 KiB
Markdown
371 lines
11 KiB
Markdown
# AGENTS.md - AI Coding Agent Guidelines
|
||
|
||
本文档为 AI 编程助手提供此 TanStack Start 全栈项目的开发规范和指南。
|
||
|
||
## 项目概览
|
||
|
||
- **框架**: TanStack Start (React SSR 框架，文件路由)
|
||
- **运行时**: Bun
|
||
- **语言**: TypeScript (strict mode, ESNext)
|
||
- **样式**: Tailwind CSS v4
|
||
- **数据库**: PostgreSQL + Drizzle ORM
|
||
- **状态管理**: TanStack Query
|
||
- **路由**: TanStack Router (文件路由)
|
||
- **RPC**: ORPC (类型安全 RPC，契约优先)
|
||
- **构建工具**: Vite + Turbo
|
||
- **代码质量**: Biome (格式化 + Lint)
|
||
- **桌面壳** (可选): Tauri v2 (详见 `src-tauri/AGENTS.md`)
|
||
|
||
## 依赖管理
|
||
|
||
### Bun Catalog 系统
|
||
|
||
项目使用 **Bun Catalog** 统一管理依赖版本（定义在根目录 `package.json` 的 `catalog` 字段）。
|
||
|
||
**安装依赖的正确方式**：
|
||
```bash
|
||
# ✅ 正确：使用 catalog: 前缀
|
||
bun add <package-name>@catalog:
|
||
|
||
# ❌ 错误：直接安装会绕过版本统一管理
|
||
bun add <package-name>@latest
|
||
```
|
||
|
||
**示例**：
|
||
```bash
|
||
# 添加 systeminformation 依赖到 packages/utils
|
||
cd packages/utils
|
||
bun add systeminformation@catalog:
|
||
|
||
# 添加 react 依赖到 apps/server
|
||
cd apps/server
|
||
bun add react@catalog:
|
||
```
|
||
|
||
**为什么使用 Catalog**：
|
||
- 确保 monorepo 中所有包使用相同版本
|
||
- 集中管理依赖版本，避免版本冲突
|
||
- 简化依赖升级（只需修改根 package.json）
|
||
|
||
**添加新依赖的步骤**：
|
||
1. 在根目录 `package.json` 的 `catalog` 字段添加依赖及版本
|
||
2. 在目标包中使用 `bun add <package>@catalog:` 安装
|
||
|
||
## 构建、Lint 和测试命令
|
||
|
||
### 开发
|
||
```bash
|
||
bun dev # 使用 Turbo 并行启动 Tauri + Vite 开发服务器
|
||
bun dev:vite # 仅启动 Vite 开发服务器 (localhost:3000)
|
||
bun dev:tauri # 启动 Tauri 桌面应用
|
||
bun db:studio # 打开 Drizzle Studio 数据库管理界面
|
||
```
|
||
|
||
### 构建
|
||
```bash
|
||
bun build # 完整构建 (Vite → 编译 → Tauri 打包)
|
||
bun build:vite # 仅构建 Vite (输出到 .output/)
|
||
bun build:compile # 编译为独立可执行文件 (使用 build.ts)
|
||
bun build:tauri # 构建 Tauri 桌面安装包
|
||
```
|
||
|
||
### 代码质量
|
||
```bash
|
||
bun typecheck # 运行 TypeScript 编译器检查 (tsc -b)
|
||
bun fix # 运行 Biome 自动修复格式和 Lint 问题
|
||
biome check . # 检查但不自动修复
|
||
biome format --write . # 仅格式化代码
|
||
```
|
||
|
||
### 数据库
|
||
```bash
|
||
bun db:generate # 从 schema 生成迁移文件
|
||
bun db:migrate # 执行数据库迁移
|
||
bun db:push # 直接推送 schema 变更 (仅开发环境)
|
||
```
|
||
|
||
### 测试
|
||
**注意**: 当前未配置测试框架。添加测试时:
|
||
- 使用 Vitest 或 Bun 内置测试运行器
|
||
- 运行单个测试文件: `bun test path/to/test.ts`
|
||
- 运行特定测试: `bun test -t "测试名称模式"`
|
||
|
||
## 代码风格指南
|
||
|
||
### 格式化 (Biome)
|
||
|
||
**缩进**: 2 空格 (不使用 tab)
|
||
**换行符**: LF (Unix 风格)
|
||
**引号**: 单引号 `'string'`
|
||
**分号**: 按需 (ASI - 自动分号插入)
|
||
**箭头函数括号**: 始终使用 `(x) => x`
|
||
|
||
示例:
|
||
```typescript
|
||
const myFunc = (value: string) => {
|
||
return value.toUpperCase()
|
||
}
|
||
```
|
||
|
||
### 导入组织
|
||
|
||
Biome 自动组织导入。顺序:
|
||
1. 外部依赖
|
||
2. 内部导入 (使用 `@/*` 别名)
|
||
3. 类型导入 (仅导入类型时使用 `type` 关键字)
|
||
|
||
示例:
|
||
```typescript
|
||
import { createFileRoute } from '@tanstack/react-router'
|
||
import { oc } from '@orpc/contract'
|
||
import { z } from 'zod'
|
||
import { db } from '@/db'
|
||
import { todoTable } from '@/db/schema'
|
||
import type { ReactNode } from 'react'
|
||
```
|
||
|
||
### TypeScript
|
||
|
||
**严格模式**: 启用了额外的严格检查
|
||
- `strict: true`
|
||
- `noUncheckedIndexedAccess: true` - 数组/对象索引返回 `T | undefined`
|
||
- `noImplicitOverride: true`
|
||
- `noFallthroughCasesInSwitch: true`
|
||
|
||
**模块解析**: `bundler` 模式 + `verbatimModuleSyntax`
|
||
- 导入时始终使用 `.ts`/`.tsx` 扩展名
|
||
- 使用 `@/*` 路径别名指向 `src/*`
|
||
|
||
**类型注解**:
|
||
- 公共 API 的函数参数和返回类型必须注解
|
||
- 优先使用显式类型而非 `any`
|
||
- 对象形状用 `type`，可扩展契约用 `interface`
|
||
- 不可变 props 使用 `Readonly<T>`
|
||
|
||
### 命名规范
|
||
|
||
- **文件**: 工具函数用 kebab-case，组件用 PascalCase
|
||
- `utils.ts`, `todo.tsx`, `NotFound.tsx`
|
||
- **路由**: 遵循 TanStack Router 约定
|
||
- `routes/index.tsx` → `/`
|
||
- `routes/__root.tsx` → 根布局
|
||
- **组件**: PascalCase 箭头函数 (Biome 规则 `useArrowFunction` 强制)
|
||
- **函数**: camelCase
|
||
- **常量**: 真常量用 UPPER_SNAKE_CASE，配置对象用 camelCase
|
||
- **类型/接口**: PascalCase
|
||
|
||
### React 模式
|
||
|
||
**组件**: 使用箭头函数
|
||
```typescript
|
||
const MyComponent = ({ title }: { title: string }) => {
|
||
return <div>{title}</div>
|
||
}
|
||
```
|
||
|
||
**路由**: 使用 `createFileRoute` 定义路由
|
||
```typescript
|
||
export const Route = createFileRoute('/')({
|
||
component: Home,
|
||
})
|
||
```
|
||
|
||
**数据获取**: 使用 TanStack Query hooks
|
||
- `useSuspenseQuery` - 保证有数据
|
||
- `useQuery` - 数据可能为空
|
||
|
||
**Props**: 禁止直接修改 props (Biome 规则 `noReactPropAssignments`)
|
||
|
||
### 数据库 Schema (Drizzle)
|
||
|
||
- 在 `src/db/schema/*.ts` 定义 schema
|
||
- 从 `src/db/schema/index.ts` 导出
|
||
- 使用 `drizzle-orm/pg-core` 的 PostgreSQL 类型
|
||
- 主键使用 `uuidv7()` (需要 PostgreSQL 扩展)
|
||
- 始终包含 `createdAt` 和 `updatedAt` 时间戳
|
||
|
||
示例:
|
||
```typescript
|
||
import { pgTable, text, timestamp, uuid } from 'drizzle-orm/pg-core'
|
||
import { sql } from 'drizzle-orm'
|
||
|
||
export const myTable = pgTable('my_table', {
|
||
id: uuid().primaryKey().default(sql`uuidv7()`),
|
||
name: text().notNull(),
|
||
createdAt: timestamp({ withTimezone: true }).notNull().defaultNow(),
|
||
updatedAt: timestamp({ withTimezone: true }).notNull().defaultNow().$onUpdateFn(() => new Date()),
|
||
})
|
||
```
|
||
|
||
### 环境变量
|
||
|
||
- 使用 `@t3-oss/env-core` 进行类型安全的环境变量验证
|
||
- 在 `src/env.ts` 定义 schema
|
||
- 服务端变量: 无前缀
|
||
- 客户端变量: 必须有 `VITE_` 前缀
|
||
- 使用 Zod schema 验证
|
||
|
||
### 错误处理
|
||
|
||
- 异步操作使用 try-catch
|
||
- 抛出带有描述性消息的错误
|
||
- 用户界面错误优先使用 Result 类型或错误边界
|
||
- 适当记录错误 (避免记录敏感数据)
|
||
|
||
### 样式 (Tailwind CSS)
|
||
|
||
- 使用 Tailwind v4 工具类
|
||
- 通过 `@/styles.css?url` 导入样式
|
||
- 优先使用组合而非自定义 CSS
|
||
- 响应式修饰符: `sm:`, `md:`, `lg:`
|
||
- UI 文本适当使用中文
|
||
|
||
## 目录结构
|
||
|
||
```
|
||
src/
|
||
├── components/ # 可复用 React 组件
|
||
├── db/
|
||
│ ├── schema/ # Drizzle schema 定义
|
||
│ └── index.ts # 数据库实例
|
||
├── integrations/ # 第三方集成 (TanStack Query/Router)
|
||
├── lib/ # 工具函数
|
||
├── orpc/ # ORPC (RPC 层)
|
||
│ ├── contracts/ # 契约定义 (input/output schemas)
|
||
│ ├── handlers/ # 服务端过程实现
|
||
│ ├── middlewares/ # 中间件 (如 DB provider)
|
||
│ ├── contract.ts # 契约聚合
|
||
│ ├── router.ts # 路由组合
|
||
│ ├── server.ts # 服务端实例
|
||
│ └── client.ts # 同构客户端
|
||
├── routes/ # TanStack Router 文件路由
|
||
│ ├── __root.tsx # 根布局
|
||
│ ├── index.tsx # 首页
|
||
│ └── api/rpc.$.ts # ORPC HTTP 端点
|
||
├── env.ts # 环境变量验证
|
||
└── router.tsx # 路由配置
|
||
```
|
||
|
||
## 重要提示
|
||
|
||
- **禁止** 编辑 `src/routeTree.gen.ts` - 自动生成
|
||
- **禁止** 提交 `.env` 文件 - 使用 `.env.example` 作为模板
|
||
- **必须** 在提交前运行 `bun fix`
|
||
- **必须** 使用 `@/*` 路径别名而非相对导入
|
||
- **必须** 利用 React Compiler (babel-plugin-react-compiler) - 避免手动 memoization
|
||
|
||
## Git 工作流
|
||
|
||
1. 按照上述风格指南进行修改
|
||
2. 运行 `bun fix` 自动格式化和 lint
|
||
3. 运行 `bun typecheck` 确保类型安全
|
||
4. 使用 `bun dev` 本地测试变更
|
||
5. 使用清晰的描述性消息提交
|
||
|
||
## 常见模式
|
||
|
||
### 创建 ORPC 过程
|
||
|
||
**步骤 1: 定义契约** (`src/orpc/contracts/my-feature.ts`)
|
||
```typescript
|
||
import { oc } from '@orpc/contract'
|
||
import { z } from 'zod'
|
||
|
||
export const myContract = {
|
||
get: oc.input(z.object({ id: z.uuid() })).output(mySchema),
|
||
create: oc.input(createSchema).output(mySchema),
|
||
}
|
||
```
|
||
|
||
**步骤 2: 实现处理器** (`src/orpc/handlers/my-feature.ts`)
|
||
```typescript
|
||
import { os } from '@/orpc/server'
|
||
import { dbProvider } from '@/orpc/middlewares'
|
||
|
||
export const get = os.myFeature.get
|
||
.use(dbProvider)
|
||
.handler(async ({ context, input }) => {
|
||
return await context.db.query.myTable.findFirst(...)
|
||
})
|
||
```
|
||
|
||
**步骤 3: 注册到契约和路由**
|
||
```typescript
|
||
// src/orpc/contract.ts
|
||
export const contract = { myFeature: myContract }
|
||
|
||
// src/orpc/router.ts
|
||
import * as myFeature from './handlers/my-feature'
|
||
export const router = os.router({ myFeature })
|
||
```
|
||
|
||
**步骤 4: 在组件中使用**
|
||
```typescript
|
||
import { orpc } from '@/orpc'
|
||
const query = useSuspenseQuery(orpc.myFeature.get.queryOptions({ id }))
|
||
const mutation = useMutation(orpc.myFeature.create.mutationOptions())
|
||
```
|
||
|
||
---
|
||
|
||
## 已知问题与解决方案
|
||
|
||
### 构建问题
|
||
|
||
**问题**: Vite 8.0.0-beta.9 与 Nitro 插件存在兼容性问题
|
||
- **错误**: `TypeError: Cannot redefine property: viteMetadata`
|
||
- **影响**: `bun run build` 构建失败
|
||
- **解决方案**: 等待 Vite 8.0 正式版发布修复，开发环境（`bun dev`）不受影响
|
||
- **临时方案**: 如需生产构建，可降级到 Vite 5.x 稳定版
|
||
|
||
### 依赖选择经验
|
||
|
||
**ohash vs crypto.createHash**
|
||
|
||
在实现硬件指纹功能时，曾误判 `ohash` 不适合用于硬件指纹识别。经深入研究发现：
|
||
|
||
**事实**：
|
||
- `ohash` 内部使用**完整的 SHA-256** 算法（256 位）
|
||
- 输出 43 字符 Base64URL 编码（等价于 64 字符 Hex）
|
||
- 碰撞概率与 `crypto.createHash('sha256')` **完全相同**（2^128）
|
||
- 自动处理对象序列化，代码更简洁
|
||
|
||
**对比**：
|
||
```typescript
|
||
// ohash - 推荐用于对象哈希
|
||
import { hash } from 'ohash'
|
||
const fingerprint = hash(systemInfo) // 一行搞定
|
||
|
||
// crypto - 需要手动序列化
|
||
import { createHash } from 'node:crypto'
|
||
const fingerprint = createHash('sha256')
|
||
.update(JSON.stringify(systemInfo))
|
||
.digest('base64url')
|
||
```
|
||
|
||
**结论**：
|
||
- ✅ `ohash` 完全适合硬件指纹场景（数据来自系统 API，非用户输入）
|
||
- ✅ 两者安全性等价，选择取决于代码风格偏好
|
||
- ⚠️ ohash 文档警告的"序列化安全性"仅针对**用户输入**场景
|
||
|
||
**经验教训**：
|
||
- 不要仅凭名称（"短哈希"）判断库的实现
|
||
- 深入研究文档和源码再做技术决策
|
||
- 区分"用户输入场景"和"系统数据场景"的安全要求
|
||
|
||
### Git 工作流要求
|
||
|
||
**重要原则**：保持代码仓库与文档同步
|
||
|
||
当遇到技术问题、做出架构决策、或发现重要经验时：
|
||
1. **立即更新 AGENTS.md**：记录问题、原因、解决方案
|
||
2. **持续同步**：每次重大变更后更新文档
|
||
3. **版本关联**：在文档中标注相关的库版本、commit hash
|
||
|
||
这确保未来的开发者（包括 AI 助手）能快速理解项目历史和技术选择。
|
||
|
||
---
|
||
|
||
**最后更新**: 2026-01-24
|
||
**项目版本**: 基于 package.json 依赖版本
|