Code Review Assistant
自动化代码审查助手,帮助开发者快速审查代码,提高代码质量。
功能
- - 🔍 自动代码审查
- 🐛 Bug 检测
- 🔒 安全漏洞扫描
- 📝 代码风格建议
- 📊 复杂度分析
- ✅ 最佳实践检查
支持的语言
| 语言 | 支持 |
|---|
| JavaScript/TypeScript | ✅ |
| Python |
✅ |
| Go | ✅ |
| Rust | ✅ |
| Java | ✅ |
| C/C++ | ✅ |
使用方法
审查单个文件
CODEBLOCK0
审查 Git Diff
CODEBLOCK1
审查 PR
CODEBLOCK2
输出示例
CODEBLOCK3 javascript
const query = SELECT * FROM users WHERE id = ${userId};
→ Use parameterized queries instead
#### 🟡 Medium Priority (2)
2. **Line 23: Missing Error Handling**
javascript
const data = JSON.parse(response);
→ Add try-catch block
3. **Line 67: Hardcoded API Key**
javascript
const API_KEY = "sk-1234567890";
CODEBLOCK6
配置
规则配置
CODEBLOCK7
忽略文件
创建 .codereviewignore 文件:
CODEBLOCK8
安装
CODEBLOCK9
CI/CD 集成
GitHub Actions
CODEBLOCK10
变现思路
- 1. GitHub Marketplace - 发布 GitHub Action
- 付费规则集 - 提供专业版规则
- 企业版 - 自托管版本
- 代码质量服务 - 为企业提供代码审查服务
代码审查助手
自动化代码审查助手,帮助开发者快速审查代码,提高代码质量。
功能
- - 🔍 自动代码审查
- 🐛 Bug 检测
- 🔒 安全漏洞扫描
- 📝 代码风格建议
- 📊 复杂度分析
- ✅ 最佳实践检查
支持的语言
| 语言 | 支持 |
|---|
| JavaScript/TypeScript | ✅ |
| Python |
✅ |
| Go | ✅ |
| Rust | ✅ |
| Java | ✅ |
| C/C++ | ✅ |
使用方法
审查单个文件
bash
code-review-assistant review path/to/file.js
指定语言
code-review-assistant review path/to/file.py --language python
审查 Git Diff
bash
审查当前的 git diff
code-review-assistant diff
审查特定分支
code-review-assistant diff main..feature-branch
审查 PR
bash
code-review-assistant pr --owner username --repo reponame --pr-number 123
输出示例
markdown
代码审查报告
文件: src/utils.js
发现的问题: 3
🔴 高优先级 (1)
- 1. 第45行: 潜在的SQL注入
javascript
const query = SELECT * FROM users WHERE id = ${userId};
→ 请改用参数化查询
🟡 中优先级 (2)
- 2. 第23行: 缺少错误处理
javascript
const data = JSON.parse(response);
→ 请添加 try-catch 块
- 3. 第67行: 硬编码的API密钥
javascript
const API_KEY = sk-1234567890;
→ 请使用环境变量
🟢 建议 (5)
- - 考虑使用 const 替代 let
- 添加 JSDoc 注释
- 提取第100行的函数
- ...
总结
0 |
| 最佳实践 | 3 |
| 代码风格 | 2 |
建议: 在合并前修复高优先级问题
配置
规则配置
bash
启用/禁用特定规则
code-review-assistant config --enable security,performance --disable style
设置严重级别
code-review-assistant config --severity high
忽略文件
创建 .codereviewignore 文件:
忽略 node_modules
node_modules/
忽略构建输出
dist/
build/
安装
bash
无需额外依赖
使用内置代码分析
CI/CD 集成
GitHub Actions
yaml
name: 代码审查
on: [pull_request]
jobs:
review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: 运行代码审查
run: |
code-review-assistant review . --output report.md
- name: 上传报告
uses: actions/upload-artifact@v3
with:
name: code-review-report
path: report.md
变现思路
- 1. GitHub Marketplace - 发布 GitHub Action
- 付费规则集 - 提供专业版规则
- 企业版 - 自托管版本
- 代码质量服务 - 为企业提供代码审查服务