关于 review-as-json
review-as-json 是用于代码审查的 skill,运行 `/review` 并以单个 JSON 对象输出结果,而非散文报告。其结构包含结论、严重程度、发现类型、类别和摘要,便于形成结构化审查结果。
主要功能
- 01运行 `/review` 流程
- 02输出单个 JSON 对象
- 03标注结论与严重程度
- 04按审查阶段分类发现
- 05要求发现附有具体证据
适用场景
- 01生成机器可读的代码审查
- 02将审查发现传入 CI 输出
- 03报告已核实的问题与疑问
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ elliottlawson/ open-review --skill review-as-json安装后在 Claude Code 中输入/review-as-json确认已加载。
详细介绍
以 JSON 格式审查
对这项更改运行 /review,并严格遵循其要求。
将结果输出为单个 JSON 对象,而不是文字报告:
{
"verdict": "approve | changes_needed | hold",
"summary": "One or two sentences on the change overall.",
"findings": [
{
"severity": "critical | warning | info",
"type": "issue | suggestion | question",
"category": "mission | architecture | implementation | craft | security | performance",
"title": "Short imperative, e.g. 'Sanitize user input before query'",
"description": "What it is, why it matters, and the consequence.",
"file": "path/to/file.ts",
"line": 42,
"suggestedFix": "Optional concrete fix."
}
],
"passes": {
"mission": "met | missing | different | unclear",
"architecture": "ok | concern | blocking",
"implementation": "ok | concern | blocking",
"craft": "ok | concern | blocking",
"security": "ok | concern | blocking",
"performance": "ok | concern | blocking"
},
"sectionSummaries": {
"mustFix": "1-2 sentences on the critical findings, if any.",
"shouldFix": "1-2 sentences on the warnings, if any.",
"questions": "1-2 sentences on the questions, if any.",
"suggestions": "1-2 sentences on the suggestions, if any."
}
}
输出规则:
- 只输出 JSON 对象。不要添加前言、评论或 Markdown 代码围栏。
- 严重程度。
critical会阻止合并(漏洞、安全漏洞、数据丢失)。warning应予以处理,但不会阻止合并。info是备注。 - 摘要。 不要重述结论(“此 PR 已获批准”“请求更改”)——呈现层会显示这些内容。摘要应说明原因。
- sectionSummaries。 说明主题本身(“新增端点均缺少输入验证”),不要只统计发现项的数量。
- 类型。
question表示需要得到答复,而不是缺陷。suggestion表示可选的改进。其他所有情况都是issue。 - 类别。 每条发现的
category都是发现它的审查阶段——CI 输出会按此显示各阶段的结果。 - 标记前先验证仍然适用。每条发现都必须提供具体的文件、行号和后果。如果无法验证,请将其设为
question。 - 如果没有发现,请输出空的
findings数组,并将结论设为approve。
评论
支持 Markdown