常用的AGENTS.md文件配置

以react项目为例:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
## 工程项目约定
- `src/`:业务与页面代码
- `src/test/`:测试初始化与测试工具
- `.github/workflows/`:CI 工作流
- `.husky/`:本地 Git hooks

## 开发命令约定

- `pnpm dev`: 启动开发服务器
- `pnpm build`:类型检查并构建生产包
- `pnpm preview`:预览构建产物
- `pnpm lint`:执行ESLint检查
- `pnpm typecheck`:执行TypeScript`类型检查
- `pnpm test`:执行Vitest单元测试
- `pnpm spellcheck`:执行cspell拼写检查

## 质量门禁

- 每次代码修改后必须执行`pnpm lint`
- 提交前通过`.husky/pre-commit`自动执行`lint-staged`
- 提交前通过`.husky/pre-push`自动执行`pnpm check`
- CI必须通过`pnpm check``pnpm build`

## ESLint 与 Typescript 规则

- ESLint使用 Typescript + React Hooks + React Refresh规则
- Typescript启用严格模式,禁止未使用的变量和参数
- 配置`eslint-config-prettier`避免格式化规则冲突

## 测试规范

- 测试框架: Vitest + Testing Library + jsdom
- 新增功能至少包含一个行为级测试用例

## 拼写检查范围

- 检查范围:`src``public`、根目录配置、`.github`、Markdown文档

## 工程原则:

- 优先简单可读方案,避免引入不必要的复杂度
- 仅实现当前需求,禁止提前实现未来功能
- 识别并消除重复逻辑,统一同类实现模式
- 保持职责清晰、依赖抽象、接口专一和可扩展
- 新增功能、功能迭代同步到Readme.md文件中

常用的AGENTS.md文件配置
https://zouhualu.github.io/20260428/常用的AGENTS-md文件配置/
作者
花鹿
发布于
2026年4月28日
许可协议