SuperAPI AI 工具集

pr-review

编程与开发

查看项目

更新于 10-16 06:58

技能介绍

用途

pr-review 是一个在提交代码与推送 PR 之前执行的自动化技术验证技能(Skill)。其目标是在每次 commit 前、以及推送 PR 之前,对改动进行系统化的技术校验,发现类型错误、lint 问题、调试残留与潜在风险,并给出明确的放行结论。

主要能力

该技能按阶段执行以下检查:

Phase 0:运行时环境检查(可自动解决)

验证开发环境是否就绪,对安全的问题自动处理,对风险操作则提示用户确认。包括:

  • 0.1 依赖检查:检查 node_modules 是否存在、package-lock.json 是否比 node_modules 更新;若缺失或过期则自动执行 npm install。
  • 0.2 Docker 容器:检查 well_postgres 与 well_hasura 是否运行;若未运行则自动执行 cd apps/api/docker && docker compose up -d,最多等待 30 秒容器健康。
  • 0.3 数据库迁移:用 cd apps/api && npm run mikro:up -- --dry-run 检查是否有待执行迁移;若有则只提示警告,不自动运行,等待用户确认。
  • 0.4 API Server(端口 8080):通过 curl 检查 /health 是否返回 HTTP 200;无进程则提示启动,进程存在但无响应则让用户选择终止重启、跳过或中止提交。
  • 0.5 Web Server(端口 3000):同上逻辑,检查并提示启动 apps/web 的 dev 服务。
  • 0.6 构建缓存:仅在 typecheck 通过但运行时报错(如 module not found、代码陈旧)时执行 npm run clean。
  • 0.7 输出运行时环境表格,标明各服务状态与采取的动作,并给出 READY 或 WAITING。

Phase 1:技术验证

  • 1.1 类型检查:运行 npm run typecheck,期望退出码 0、无错误。
  • 1.2 Lint 检查:运行 npm run lint,期望退出码 0、无错误。
  • 1.3 ReadLints 集成:对改动文件使用 Cursor 的 ReadLints 工具,按 Error(BLOCK,必须修复)、Warning(WARN,建议修复)、Info(PASS,仅信息)分类。

Phase 2:代码质量检查

  • 2.1 检测 console.log:在改动文件中用 Grep 搜索 console.(log|debug|warn|error),发现则 WARN,建议提交前移除。
  • 2.2 检测 TODO/FIXME:搜索 (TODO|FIXME|HACK|XXX):,发现则 INFO,建议记录或处理。
  • 2.3 硬编码值:搜索 (localhost|127.0.0.1|hardcoded),发现则 WARN,建议改用环境变量。

Phase 3:风险评估

依据以下因素计算风险分:

  • 改动行数:<50=1,50-200=2,>200=3
  • 改动文件数:<5=1,5-10=2,>10=3
  • 新增依赖:无=0,1=1,>1=2
  • API 变更:无=0,内部=1,公开=2
  • 数据库变更:无=0,字段=1,实体=2 风险等级:LOW(0-4)常规审查;MEDIUM(5-8)仔细审查;HIGH(9+)建议彻底审查。

输出格式与结论逻辑

最终输出 PR Review Report,包含运行时环境、技术验证、代码质量、风险评估与 Verdict 表格。Verdict 判定规则:运行时 WAITING 或用户选择中止 → BLOCK;类型检查或 Lint 失败 → BLOCK;ReadLints 有 Error → BLOCK;迁移待执行、存在 console.log、风险 HIGH → WARN;全部通过 → PASS。

使用方式

该技能在以下场景被调用:

  • commit.mdc:每次提交前
  • push-pr.mdc:Phase 1.1 验证
  • agent.mdc:作为提交级工作流的一部分 也可手动触发:输入 "use pr-review skill"。

对于快速迭代,可运行 Quick Mode:执行 npm run typecheck、npm run lint、检查无 console.log,全部通过即 PASS。Quick Mode 适合中间提交,推送 PR 前应使用完整审查。

适用场景

适用于使用 Node.js/npm 项目、含 Docker(well_postgres、well_hasura)、Hasura、MikroORM 迁移(mikro:up)、API(端口 8080)与 Web(端口 3000)服务的开发流程,用于提交前门禁与 PR 推送前的质量把关。

限制

该技能高度依赖特定项目结构(apps/api、apps/web、package-lock.json、npm 脚本 typecheck/lint/clean、端口 8080/3000、Docker 容器名 well_*),通用性有限。数据库迁移不会自动执行,遇到风险操作需要用户确认。其他项目需自行调整命令与路径。关于收费、价格、平台支持范围等信息,资料暂未提供。