SuperAPI AI 工具集

pr-review-toolkit

编程与开发

查看项目

更新于 10-16 10:29

技能介绍

用途

PR Review Toolkit 用于对代码 PR(Pull Request)进行全面的代码审查。它通过 7 套专业化审查协议,让审查可以聚焦于某个特定方面,也可以运行全部适用的检查。

主要能力

工具包含以下审查维度:

  • Code Review(代码审查):关键字 code,关注项目规范、Bug 与代码质量;始终适用。
  • Test Analysis(测试分析):关键字 tests,关注覆盖质量与关键缺口;当测试文件改动时启用。
  • Silent Failures(静默失败):关键字 errors,关注错误处理与 catch 块;当错误处理改动时启用。
  • Type Design(类型设计):关键字 types,关注封装与不变量;当类型新增或修改时启用。
  • Comment Analysis(注释分析):关键字 comments,关注准确性、完整性与注释腐化;当注释或文档改动时启用。
  • Code Simplification(代码简化):关键字 simplify,关注清晰度与可维护性;在审查通过后启用。
  • Coupling Analysis(耦合分析):关键字 coupling,关注组件独立性与依赖方向;当新增模块或导入变化时启用。

使用方式

审查工作流

  1. 确定范围:识别改动文件,使用的命令包括:
    • git diff --name-only(未暂存改动)
    • git diff --cached --name-only(已暂存改动)
    • gh pr diff(如果存在 PR)
  2. 选择审查方面:如果用户指定了方面(如“review tests and errors”),则使用指定项;否则依据改动内容自动判断适用方面。
    • 始终:代码审查
    • 测试文件改动:测试分析
    • 注释/文档新增:注释分析
    • 错误处理改动:静默失败排查
    • 类型新增/修改:类型设计分析
    • 新增模块/文件或模块间导入变化:耦合分析
    • 审查通过后:代码简化(打磨)
  3. 执行审查:对每个选中的方面加载对应参考协议并应用到改动文件。支持顺序执行(默认,便于交互反馈)和并行执行(用户要求速度时同时启动全部审查)。
  4. 汇总与报告:将发现合并为按优先级排序的摘要,格式为:
    • Critical Issues(严重问题,X found)
    • Important Issues(重要问题,X found)
    • Suggestions(建议,X found)
    • Strengths(亮点)
    • Recommended Action(建议操作:先修复严重问题,再处理重要问题,考虑建议项,修复后重新审查)

评分体系

每套协议使用自己的评分来排定发现项的优先级:

  • Code Review:置信度 0-100,≥80 时报告
  • Test Analysis:严重度 1-10,聚焦 8-10
  • Silent Failures:严重度 Critical/High/Medium,全部报告
  • Type Design:4 个维度按 1-10 评分,全部报告
  • Comment Analysis:分类为 Critical/Improvement/Removal,全部报告
  • Code Simplification:定性评估,全部报告
  • Coupling Analysis:红/绿旗 → 四级评级,全部报告

使用示例

  • 完整审查(全部适用方面):“Review my PR” / “Run a comprehensive review”
  • 指定方面:“Review test coverage and error handling”“Check if the comments are accurate”“Simplify the code”
  • 并行执行:“Review everything in parallel”

推荐工作流

  1. 编写代码 → 代码审查 + 错误处理
  2. 审查架构 → 耦合分析
  3. 修复严重问题 → 重新运行针对性审查
  4. 添加测试 → 测试分析
  5. 添加文档 → 注释分析
  6. 最终打磨 → 代码简化
  7. 创建 PR

适用场景

适用于在创建 PR 前后对代码改动进行系统化审查,尤其适合希望按不同质量维度(测试、错误处理、类型、注释、耦合等)分项检查并按优先级修复的开发流程。

限制与最佳实践

建议最佳实践包括:尽早审查(在创建 PR 之前而非之后)、聚焦改动(审查 git diff 而非整个代码库)、优先处理严重问题、修复后重新运行、使用针对性审查、多次聚焦审查优于一次全面审查。

关于收费、价格、平台支持等信息,资料中暂未提供。