SuperAPI AI 工具集

review-me

编程与开发

查看项目

更新于 10-16 06:10

技能介绍

review-me 是 atelier 标准体系中的按需审查技能,用于在代码变更落地前对照 atelier 标准执行规则一致性审计。它提供常驻标准与通用审查工具单独无法给出的合规视角:对整份 diff 做一次完整检查,把每个改动文件映射到约束它的硬性规则,用领域语言引用规则编号,使违规在评审成本阶段被发现,而不是在生产环境或评审评论往返三轮之后。

用途与定位

它是常驻 atelier 标准的第三个按需伙伴:grill-me 负责决策前时刻,bootstrap 负责仓库诞生,review-me 负责落地前时刻。它不替代内置工具,而是与之互补(正如安全参考补充 /security-review):通用正确性缺陷交给 /code-review,机械性的复用、简化、抽象层级清理交给 /simplify,review-me 专注规则一致性。

适用时机

用户要求“review me”、要求对照标准审查 diff/分支/PR,或在提交前检查变更是否违反规则。变更已暂存或功能分支准备落地,需要一致性检查点。用户希望把标准引入既有仓库、迁移棕地代码库,或获得让仓库达到标准的分阶段计划——这会触发 adopt 模式。强度应与风险匹配:一行拼写修正不需要完整规则扫描,应说明并跳过。

使用方式

首先确定 diff 范围,只问一个问题并给出建议:暂存区(git diff --cached)、工作树、分支对比 origin/main(git diff origin/main...)、PR 或整个仓库(adopt 模式)。默认建议当前分支对比 origin/main。确认后先读取实际 diff 再判断。

然后把每个改动文件映射到其规则子集,规则按层区分,只审计适用的部分:src/domain/、src/use-cases/ 对应规则 1-3、6、10、12、14、16-18(信任边界使用品牌类型、主端口 SUT、返回 Result、不用 try/catch、不用自定义错误类);src/infra/** 对应 13、17、20(测试接缝、try/catch 隔离于此、用 Bun.file 而非 node:fs、通过 formatError 转换 Result);src/components/、src/page/、app/** 对应 21-22(设计系统纯净性与样式封印);.test.ts、src/test-helpers/** 对应 24、13、14(测试完整性、不从 bun:test 引入 mock、主端口 SUT、领域语言场景命名);package.json 对应 19(不用 "latest"/"");任何提交对应 23(Conventional Commits)且规模小(≤10 文件 / ≤300 行)。

每个文件都要检查通用硬性规则:不用 class / 函数声明 / interface / console.*(1-4)、导出显式返回类型(6)、单箭头而非柯里化(18)、零内联忽略任何工具(15)。

运行安全 source-to-sink 视角:是否有不可信来源在未经过品牌类型检查点的情况下到达 sink(SQL、shell、文件系统、HTTP、HTML、重定向)?应用严格的误报过滤,只保留有明确攻击路径的具体可利用发现,跳过 DoS、纵深防御加固和理论性担忧。

对机械门禁只做提示、不重新运行:测试、lint、类型检查、覆盖率、变异测试由 pre-commit 门禁 4-8 强制执行,提醒用户运行而非肉眼检查。review-me 针对的是门禁无法捕获的判断类规则。

adopt 模式(棕地)

当目标是不符合标准的既有仓库而非 diff 时,review-me 切换到 adopt 模式:扫描整棵树,然后编排迁移顺序,使仓库以绿色增量达到标准,而不是一次不可评审的重写。一致性扫描使用与上述相同的层到规则映射,只是从 diff 扩大到全部 src/**;新增工作是顺序。采用过程的大部分工作是决定哪些暂时不迁移——YAGNI 同样适用于迁移。

评估:扫描整棵树,报告哪些规则被违反、在哪里、有多普遍,按杠杆排序——工具链和测试接缝优先于外观类规则。

在不触发门禁的前提下安装门禁:添加 ESLint flat 配置、tsconfig 和钩子,但初期把执行范围限定在改动文件(lint diff,而不是上千条既有警告),避免每次提交都被阻塞。唯一被认可的绕过是初始机械脚手架/批量重命名提交——使用 --no-verify 并在提交正文中说明理由(references/workflow.md § Never bypass),绝不在检查失败时使用,绝不成为习惯。

先刻画再修改:对每个将要触碰的切片,提出固定当前行为的特征测试(规则 24——先提议、确认、再编写),使重构可证明保持行为不变。没有特征测试,就不重构。

逐切片迁移,每个都是绿色的 ≤300 行提交。一次一个垂直切片:class → module、原始类型 → 信任边界的品牌类型、IO → Result(见 references/result-type.md § Migration checklist)、console.* → Logger 端口。提交规模门禁是工作单元,不是障碍。

主干而非分支:每个切片落到 main,未完成的工作藏在标志位后(references/workflow.md § Trunk-based),绝不用长期迁移分支任其腐化。

树符合标准后把门禁切换为阻塞:完整 lint:strict、覆盖率层级、变异测试。当全新克隆无需限定范围、无需绕过即可通过全部八个门禁时,采用完成。

此模式输出的是分阶段采用计划——有序切片及第一个可开始的切片——而不是对单个 diff 的裁决。它是 bootstrap 对绿地仓库所做工作的棕地对应物:bootstrap 诞生符合标准的仓库,adopt 模式引导既有仓库走向合规。

输出

引用规则的裁决:每条发现指明文件、所违反的确切规则编号(或红旗)、原因和修复方式,按严重程度分组,用领域语言,最重要的修复放在最前。结尾给出一行裁决:符合标准,或 M 个文件中有 N 处违规。

只报告,绝不修改代码树。可按请求提供应用修复,把机械清理交给 /simplify,把正确性缺陷交给 /code-review。审查应朝向最简单的合规变更:一条要求比规则本身更多代码的发现本身就是坏味道。

在维护 .claude/LESSONS.md 日志的仓库中,反复出现的违规是候选 [mistake] 条目——经批准后提议,让下一次会话继承该修正。