SuperAPI AI 工具集

pr-review

编程与开发

查看项目

更新于 10-16 03:43

技能介绍

用途:在用户要求“review a PR”“check this pull request”等时,按项目 PR 清单和编码标准审查拉取请求,输出编号问题列表,并在获批后发布行内评论与总结评论。

主要能力与工作流分段: 一、收集上下文:未提供 PR 编号或 URL 时需向用户索取,否则不继续;支持完整 URL、#123 或纯数字。使用 gh pr view <number> --json number,title,body,author,files,additions,deletions,baseRefName,headRefName 和 gh pr diff <number> 获取元数据与差异,并据标题、正文和改动文件判断变更类型,以决定适用哪些清单项。 二、审查:读取 references/pr-checklist.md,从清单合规、代码质量、测试质量、文档质量四方面评估。清单项包括命令文件用单引号、命令类命名 [Service][Command]Command、commands.ts 中命令按字母序、remove 命令含 force 选项、用 async/await、responseType 为 json 时用 handleRejectedODataJsonPromise、list 命令用 defaultProperties、互斥选项用自定义 Zod 校验、至少一条 verbose 日志、用户输入用 formatting.encodeQueryParameter() 或 formatting.escapeXml() 转义、无 any 类型与注释代码、Bug 修复附测试、按需更新文档等。 三、呈现发现:编号列出,含文件与行引用、类别(Checklist|Code Quality|Test Quality)、严重度(Error|Warning|Suggestion)、描述与建议;无问题则说明 PR 看起来不错;按 Error、Warning、Suggestion 排序。 四、发布评论:必须先征得用户确认,再以单次 review 提交行内评论与总结;无问题用 APPROVE,有任何发现用 REQUEST_CHANGES。示例命令为 gh api repos/{owner}/{repo}/pulls/{number}/reviews --method POST --input -,请求体含 event、body、comments(path、line、side、body)。行号须对照 diff hunk 核实,指新文件行(RIGHT 侧)。评论应建设性、具体、简洁、专业,格式为 [Category | Severity] 描述,必要时附建议块。总结格式含 PR 编号标题、作者、概述、发现列表、清单覆盖说明。

参考:references/pr-checklist.md 为完整清单;参考实现如 src/m365/spo/commands/list/list-list.ts、src/m365/spo/commands/web/web-get.ts、src/m365/entra/commands/user/user-get.ts。

限制:需已认证并能访问仓库的 gh CLI;未提供 PR 编号或 URL 时应先索取;发布评论前须用户明确批准;行号须准确;建议块仅在修复明确且自包含时使用。具体收费、价格与平台范围暂未提供。