PR Reviewer

面向 GitHub Pull Request 的自动化代码审查工具。分析代码差异（diff），识别安全问题、错误处理缺失、风格问题及测试覆盖率不足等情况。

前置条件

• 已安装并完成身份验证的 gh CLI（运行 gh auth status 可确认）
• 具备仓库访问权限（最低需读取权限；若需发布评论，则还需写入权限）
• 可选：安装 golangci-lint 用于 Go 语言 lint 检查，或 ruff 用于 Python 语言 lint 检查

快速开始

# 审查当前仓库中所有打开状态的 PR
scripts/github/pr-reviewer.sh check

# 审查指定编号的 PR
scripts/github/pr-reviewer.sh review 42

# 将审查结果以 GitHub 评论形式发布
scripts/github/pr-reviewer.sh post 42

# 查看所有打开状态 PR 的审查状态
scripts/github/pr-reviewer.sh status

# 列出尚未审查的 PR（适用于心跳检测/定时任务集成）
scripts/github/pr-reviewer.sh list-unreviewed

配置

可通过设置以下环境变量进行配置；若未设置，脚本将自动从当前 Git 仓库中推断：

• PR_REVIEW_REPO — GitHub 仓库名，格式为 owner/repo（默认值：由 gh repo view 自动检测）
• PR_REVIEW_DIR — 本地代码检出路径，用于执行 lint 检查（默认值：当前工作目录所在的 Git 仓库根目录）
• PR_REVIEW_STATE — 状态文件路径（默认值：./data/pr-reviews.json）
• PR_REVIEW_OUTDIR — 报告输出目录（默认值：./data/pr-reviews/）

写入的目录

• PR_REVIEW_STATE（默认值：./data/pr-reviews.json）—— 记录已被审查的 PR 及其 HEAD SHA 值
• PR_REVIEW_OUTDIR（默认值：./data/pr-reviews/）—— 存放 Markdown 格式的审查报告

检查内容

智能重审（Smart Re-Review）

为每个 PR 记录其 HEAD SHA 值。仅当有新提交被推送时才触发重新审查。如需强制重新审查，请使用 review 命令。

报告格式

报告以 Markdown 文件形式保存在输出目录中。每份报告均包含以下内容：

• PR 元数据（作者、分支、变更摘要）
• 提交列表
• 按编程语言/类型归类的已变更文件
• 自动化 diff 分析结果，含文件路径、行号、问题类别与上下文代码片段
• 测试覆盖率分析
• 本地 lint 检查结果（仅当仓库已在本地检出时生效）
• 总结性结论：🔴 SECURITY / 🟡 NEEDS ATTENTION / 🔵 MINOR NOTES / ✅ LOOKS GOOD

心跳检测 / 定时任务（Heartbeat/Cron）集成

可将以下逻辑加入周期性检查流程（例如心跳服务、cron 任务或 CI 流程）：

UNREVIEWED=$(scripts/github/pr-reviewer.sh list-unreviewed)
if [ -n "$UNREVIEWED" ]; then
  scripts/github/pr-reviewer.sh check
fi

扩展性说明

脚本中的分析规则按编程语言组织。如需新增规则，请在 analyze_diff() 函数中对应语言的 pattern 列表末尾追加新条目：

# 添加一条新的 Go 语言规则
go_patterns.append((r'^+.*os.Exit(', 'RISK', 'Direct os.Exit() — consider returning error'))