用途
Code Review 技能用于自动化代码审查与分析,适用于以下场景:提交前审查代码变更、检查安全漏洞、分析代码复杂度、发现缺陷与问题、执行编码规范。
主要能力
该技能围绕命令行工具组织审查流程,主要能力包括:
- 提交前审查:使用
git diff查看未暂存变更、git diff --cached查看已暂存变更、git diff path/to/file查看特定文件变更、git diff HEAD~1查看自上次提交以来的变更、git diff main..feature-branch比较分支。支持通过git add -i、git add -p path/to/file、git add -u进行选择性暂存。 - 静态分析:提供多种 lint 工具命令,包括 ESLint(JavaScript/TypeScript)、ShellCheck(Shell 脚本)、hadolint(Dockerfile)、yamllint(YAML 文件)、jsonlint(JSON 文件)。
- 代码质量:支持 SonarQube(
sonar-scanner)、CodeClimate(codeclimate analyze)以及复杂度分析(cloc --by-file .)。 - 安全扫描:包括
npm audit、yarn audit、npm outdated依赖检查、通过gh api graphql查询 GitHub 安全公告,以及 secrets 扫描(示例中给出了一个 git clone 命令)。 - 代码审查命令:使用 grep 查找 TODO/FIXME/XXX/HACK 注释、console 调用、硬编码密码等常见问题;使用 find 与 wc 统计文件行数、函数数量。
- GitHub PR 审查:通过
gh pr diff、gh pr view --json files、gh pr view --json reviews获取 PR 差异、文件列表和审查记录。 - 审查清单脚本:提供一个 bash 脚本示例,统计 TODO/FIXME 注释数、console.log 数、潜在 secrets 数,并提示运行测试覆盖率与 lint。
- 自动化审查脚本:包含预提交钩子示例(运行 lint 与测试,失败则退出)和 GitHub Actions 工作流示例(在 pull_request 时运行 linter、测试、安全审计和构建)。
使用方式
该技能以命令行操作为主,用户可在本地仓库中直接执行上述 git、lint、安全扫描等命令,也可将提供的预提交钩子脚本放入 .git/hooks/pre-commit,或将 GitHub Actions 配置加入工作流文件。审查清单脚本可直接运行以快速获取常见问题统计。
适用场景
适用于开发者在提交代码前进行自查、在 CI 流程中自动执行代码审查、在 GitHub 上审查 Pull Request,以及需要快速扫描安全漏洞、代码复杂度或编码规范问题的场景。
限制
资料中未说明该技能的具体安装方式、依赖环境、收费模式、平台支持范围或实际效果。部分命令(如 SonarQube、CodeClimate)标注为“if configured”,需要用户自行配置。secrets 扫描示例中的 git clone 地址可能不完整或存在笔误,资料未提供进一步说明。资料末尾提到“Thepopebot can perform code reviews using LLM analysis”,但未展开其具体功能与使用方式。