SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-16 07:44

技能介绍

用途

该技能用于在代码提交前进行系统化的质量门禁审查,也适用于合并前的拉取请求审查、部署前的代码审计、关键变更的质量验证,以及需要第二意见的审查请求。它不适用于快速抽查、琐碎的拼写修正或仅涉及格式的改动。

主要能力

审查按清单分类逐项进行,覆盖以下方面:

  • 类型安全:避免无理由的 any 类型、显式处理 null/undefined、使用类型守卫与可辨识联合、为公共函数标注返回类型等。
  • 错误处理:处理所有错误路径、提供有意义的错误信息、正确传播或记录错误、处理 Promise 拒绝、在 finally 中清理资源等。
  • 安全:验证用户输入、避免硬编码密钥、检查认证授权、使用参数化查询、防止 XSS 与 CSRF、加密敏感数据、对公开端点限流等。
  • 测试:为新功能提供测试、覆盖边界与错误场景、使用真实断言、避免测试污染、合理使用 mock、为关键路径提供集成测试等。
  • 代码质量:命名体现意图、函数与文件规模控制、避免魔法数字、消除重复、控制嵌套深度与复杂度、移除死代码等。
  • 文档:公共 API 提供 JSDoc/TSDoc、解释复杂算法与非显而易见决策、记录破坏性变更、为 TODO 补充上下文与负责人、必要时更新 README 等。
  • 性能:避免明显的 N+1 查询、选用合适的数据结构、减少不必要的分配、将重操作异步或批处理、合理使用缓存、考虑数据库索引等。
  • Rust 专项(适用时):rustfmt 与 clippy 通过、优先使用 Result 而非 panic、测试与启动之外避免 unwrap/expect、遵循所有权与借用惯例、遵守 Send/Sync 约束、为 unsafe 代码提供注释说明、使用合适的错误类型等。

使用方式

技能定义了明确的公告协议:开始审查时说明审查范围、关注领域与清单方式;审查过程中发现即输出,格式为严重程度、文件路径与行号、问题描述、影响与修复建议;完成时输出按严重程度统计的发现项汇总与建议(发布 / 修复阻塞项 / 需要返工)。

严重程度分为三级:严重(阻塞,如安全漏洞、数据丢失风险、常见路径运行时崩溃、无迁移的破坏性变更、测试失败或缺失关键测试)、中等(应在合并前修复,如类型安全违规、未处理的错误情况、错误信息不佳、边界测试缺失、明显的代码质量问题、公共 API 文档缺失)、轻微(可考虑处理,如风格不一致、功能正常但过于复杂的代码、小的性能优化、文档改进、缺少上下文的 TODO、命名改进)。

执行流程为:公告审查 → 运行清单 → 记录发现项 → 调查模式 → 深入核查阻塞项 → 汇总 → 交付发现项。每个发现项需验证是否为真实问题、评估影响、确定具体修复方案,并检查是否为跨文件的系统性问题。

适用场景

提交前代码审查与质量门禁、合并前拉取请求审查、部署前系统化代码审计、关键变更的质量验证、第二意见审查请求。

限制

不适用于快速抽查、琐碎的拼写修正或仅涉及格式的改动。该技能强调不应跳过清单审查、不应在未验证的情况下假设代码安全、不应将风格偏好标记为阻塞项、不应提供没有修复指导的模糊发现项、不应将严重发现项留待以后修复、不应在缺少公告协议的情况下完成审查、不应遗漏用户输入路径的安全检查、不应忽视测试质量(执行不等于验证)。