SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 11-14 17:50

技能介绍

用途:code-review 用于按照 references/style-guide.md 中的风格指南审查代码,并生成结构化、带严重程度标签的发现报告。报告面向两类读者:人类可在约 30 秒内浏览,智能体可直接据此行动。

审查范围:默认优先级为——用户明确指定的文件、PR、分支或 diff;审查“我的改动/这个分支”时对当前分支执行 git diff main...HEAD;审查“我刚写的内容”时查看未提交改动(git diff HEAD 与 git diff --staged);仅在确实含糊时才询问用户。流程上先浏览完整 diff,再针对有实质改动的文件阅读调用点、类型与测试等周边上下文。

主要能力:审查涵盖七类视角:正确性(越界、空值、竞态、未 await 的 Promise、吞错、共享状态变更、幂等性、边界校验);风格指南符合度(命名、卫语句、渐进披露、显式依赖、错误处理、单一职责);智能体与上下文卫生(上下文边界泄漏、token 膨胀、非结构化输出、错误不可机器解析、约定漂移);极简性(过早抽象、臆测通用性、死代码、无意义注释、未上线代码的兼容层);测试(新行为缺测试、测试耦合内部实现、单测做多件事、只覆盖正常路径);安全与副作用(注入、密钥泄露、鉴权缺失、过宽 catch、意外网络/文件/进程操作);提交与 PR 卫生(混杂关注点、提交信息只写“做了什么”、夹带无关重构)。

输出格式:报告固定包含摘要以及 Blockers、Major、Minor、Nits、Praise 各节,空节直接省略,不填充“未发现问题”。每条发现一行,写明 file:line、问题、影响和具体修复方向。严重程度校准原则是宁少勿滥,一份 40 条的审查通常被忽略,6 条更可能被采纳。

限制与约定:除非用户要求,不直接重写代码,只指出问题与修复方向;按严重程度而非按文件分组;不编造问题凑数,“看起来不错”是有效结论;不引用大段代码;不说教;不把指南之外的风格偏好当作规则,品味问题归入 Nits。