Code Reviewer 是一款自动化代码审查工具,其设计灵感来自 CodeRabbit 以及其他 AI 驱动的审查系统。它用于分析代码文件中的常见问题、安全模式以及风格一致性,并基于常见质量模式生成 CODE_REVIEW.md 报告。
用途
该工具面向需要自动化代码质量分析的开发者与团队,主要覆盖以下使用场景:
- 提交前(pre-commit)代码质量检查
- Pull Request 审查自动化
- 代码库健康审计
- 安全扫描
- 风格一致性检查
主要能力
- 自动扫描代码文件,识别常见问题与安全模式。
- 支持对单个文件或整个目录进行审查。
- 支持按特定重点方向进行审查,包括安全(--security)、性能(--performance)和风格/一致性(--style)。
- 生成结构化审查报告,输出到 logs/CODE_REVIEW.md。
报告示例中包含按严重程度分类的问题条目,例如安全类提示(如潜在的 SQL 注入模式,建议改用参数化查询而非字符串拼接)和风格类建议(如变量命名不够描述性,建议使用更具描述性的变量名),并在结尾汇总问题总数与分类统计。
使用方式
安装:
cd {baseDir}
npm install
审查单个文件:
{baseDir}/review.js path/to/file.js
审查一个目录:
{baseDir}/review.js path/to/directory
按特定重点审查:
{baseDir}/review.js . --security # Focus on security issues
{baseDir}/review.js . --performance # Focus on performance issues
{baseDir}/review.js . --style # Focus on style/consistency
生成的报告保存在 logs/CODE_REVIEW.md,包含完整细节。
适用场景
适合在开发流程中引入自动化代码质量把关,例如在提交代码前做质量检查、在 PR 流程中自动执行审查、对代码库进行健康与安全审计,以及统一团队代码风格。
限制
资料中未说明该工具支持的具体编程语言范围、是否依赖特定运行时或版本要求、审查规则的完整清单、性能与准确率表现、是否需要网络或 API 密钥、许可协议及维护状态。以上信息暂未提供。