左栏商品名显示成光款号(如 PLTK016)的根因是双层解析不一致:api 写路径按 首括号对解析产出「童装…(DTG180) PLTK016」,admin 展示解析按末括号取品名 误显示成 PLTK016。 - admin parseLinkName 对齐 api 首括号对解析 + 无 SKU 段中文品名守卫, cleanLinkName 剥离 ASCII 型号限定词(中文括号内容保留) - api 新增 cleanGoodDisplayName/describePureSkuGoodName,接入 create/update/ batchCreate(batchCreate 补上缺失的 normalize);纯款号按 SDS 分类名补描述 - 新增幂等存量修复脚本 fix:good-names(默认 dry-run,--apply 写库) - 已执行:V2 栈 34 条限定词名、V1 栈 213 条原始链接名规范化,复跑幂等 0 Tests: api 22 suites/199 passed, admin 27 passed, tsc clean
7.1 KiB
AGENT.md - AI Agent 开发规范
开发流程
1. 梳理需求
使用 brainstorming 进行头脑风暴, 文档存放与命名规则如下:
| 需求类型 | 计划目录 | 命名规则 | 示例 |
|---|---|---|---|
| 新功能 | plans/feature/ |
xxx-xxx-feature.md |
smart-view-feature.md |
| 修 Bug | plans/fix/ |
xxx-xxx-fix.md |
token-refresh-fix.md |
| 重构 | plans/refactor/ |
xxx-xxx-refactor.md |
api-split-refactor.md |
使用 writing-plans 技能制定实施计划
开发新功能时必须评估权限需求:每个新功能/新操作都需要考虑是否需要纳入权限控制。具体评估方式见下方「权限系统」章节。
可参考的开发文档位于 docs/dev/*
2. 建立开发分支
确定好需求之后,就使用 enterprise-git-spec 技能来建立分支。
3. 按照需求开发
按照当前功能的计划文档的任务项及其任务细节来逐步实现功能, 全程严格地遵循技能 test-driven-development 进行 TDD 开发流程, 并遵循 executing-plans 技能来执行开发计划。
重要原则:所有测试必须通过
- 开发过程中,必须确保所有测试用例都通过,包括新功能的测试和现有功能的测试
- 如果发现现有测试失败,必须立即修复,确保新功能不会破坏旧功能
- 只有在所有测试都通过的情况下,才能认为开发完成
所有任务完成后请遵循 verification-before-completion 技能完成验证
4. 合并到开发分支
所有测试通过后,使用 enterprise-git-spec 技能提交分支,然后合并回 develop 分支。
5. 沉淀开发经验
在实现功能过程中,将适用于任何项目的编码好想法、好思想、注意点等有助于项目推进的内容,及时追加到 AGENT.md 中。这些经验是跨功能、跨项目的通用知识,帮助后续开发少走弯路。
6. 更新项目结构文档
每次功能开发完成后,更新 docs/references/structs.md 文件。该文件记录整个项目的目录结构和每个模块的简要功能描述,便于每次迭代功能时快速理解整个项目全貌。
7. 更新使用文档
使用文档分为:
README.md- 面向人类使用者,帮助其快速上手项目。仅在新功能开发完成后更新。内容保持简洁,聚焦于让用户快速跑通基础流程。docs/references/*- 面向人类使用者,提供项目的全面使用指南,支持深度探索模块与命令行细节。每次新功能开发完成或已有功能调整后必须更新。示例要丰富,帮助使用者理解各项功能的具体用法。skills/[项目名]/SKILL.md- 面向 LLM / AI Agent,指导大模型如何使用本项目。
快速开始文档每次新功能开发完成后才更新,具体更新 README.md 文件。确保文档包含新增功能的使用示例、命令说明和注意事项,帮助用户快速上手。
详细使用文档位于 docs/references/*,目录文件为 docs/references/index.md,请按照功能划分参考文档,并填充详细的使用说明,帮助用户深度探索模块/命令行的使用。每次新功能或旧功能调整了请更新最新的使用方法,例子应该丰富一些,便于使用者理解功能使用。
AGENT使用技能文档位于 skills/[项目名]/*,入口文件为 skills/[项目名]/SKILL.md,更新时机和要求与详细使用文档一致。
开发规范
代码优化
遵循 improve-codebase-architecture
类型规范
参考技能 typescript-advanced-types
测试规范
参考技能 javascript-testing-patterns
测试
每个任务目录应有对应的测试文件 test/sync/tasks/<task-name>/handler.test.ts。
数据库设计
PostgreSQL 最佳设计实践: postgresql-table-design 技能 PostgreSQL 最佳性能调优实践: supabase-postgres-best-practices 技能 Prisma Postgres 最佳实践: prisma-postgres 技能
后端规范
参考 nestjs-best-practices 技能
你可以自己增加规范
经验沉淀(跨项目通用)
- 数据库漂移处理:连共享开发库时先跑
prisma migrate status;若报"列已存在"类错误,说明有人用db push带外改过库,用prisma migrate resolve --applied <name>把已存在的迁移标记为已应用,再migrate deploy应用真正缺的部分。切勿盲目 reset 共享库。 - 连真实库的集成测试隔离:jest 并行套件共用一个数据库时,(a) 夹具的天然键(sdsCategoryId、名称等)必须带运行时间戳唯一化,禁止跨运行共享字面量;(b) 全量型操作(如 auto-group 扫全库)会顺带扫到其他并行套件的夹具,其写入路径必须对"成员中途消失"宽容(跳过而非抛错),否则会随机挂测试。
- 跑全量 jest 前先停 dev server:
nest start --watch等常驻进程与测试共用数据库时,其重编译窗口/后台钩子会与测试写入竞争,造成"单跑绿、全量偶发红"的假阳性;验证基线前先停掉所有 watch 进程再跑。 - 中文断言勿手写字面量排序:JS
Array.sort()对中文按 UTF-16 码位排(如 烫 U+70EB < 直 U+76F4),手写期望序列容易按拼音/习惯顺序写反;比较选项集合时用expect.arrayContaining+ 长度,或对两侧统一.sort()后再比较。 - 测试夹具必须自包含:断言库内"存在某类数据"的用例(如标签组过滤)在全新/一次性数据库上必挂;夹具自己种下断言所依赖的数据,不依赖共享库的既有状态。
- 严禁直接热修运行容器内的代码:本次线上 v2 镜像内被塞过未提交的词表改动(热转印),仓库重建镜像即复发且难排查;所有修复必须落在仓库并重建部署。排查"线上行为与代码不符"时先
md5sum比对容器内源文件与仓库。 - 两端"同构"解析器必须连测试用例也同构:admin 与 api 各有一份链接名解析器,本次展示 bug(
品名(DTG180) SKU显示成光款号)正是两端取括号策略不一致(api 首括号对 vs admin 末括号)所致。改任何一端解析行为时,另一端同样输入的用例必须同步补上(origin-name.spec ↔ origin-name.parser.spec/goods.service.spec)。 - 共享开发库不可达时用一次性 docker postgres 跑集成测试:
docker run -d --name inkreach-test-pg -e POSTGRES_USER=test -e POSTGRES_PASSWORD=test -e POSTGRES_DB=inkreach_test -p 127.0.0.1:54329:5432 postgres:16-alpine→DATABASE_URL=… npx prisma migrate deploy→ jest/vitest 指向该库;用完docker rm -f。夹具自包含的套件在新库上直接绿。 - 宿主机即部署机时,改生产数据前先
docker inspect拿容器真实注入的环境变量:deploy/.env 里的密码可能与运行容器不一致(v2 栈独立 env);对两个栈的库做数据修复时,dry-run 清单必须逐栈分别核对后再 apply。