关于 code-reviewer
code-reviewer 是面向开发者的代码审查技能,结合脚本进行 PR 分析、代码质量检查和审查报告生成,并提供参考指南。
主要功能
- 01PR 分析脚本
- 02代码质量分析与建议
- 03生成审查报告
- 04审查清单与编码规范
- 05反模式参考指南
适用场景
- 01分析拟议的代码变更
- 02检查代码库的质量问题
- 03生成代码审查报告
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ davila7/ claude-code-templates --skill code-reviewer安装后在 Claude Code 中输入/code-reviewer确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/code_review_checklist.mdcoding_standards.mdcommon_antipatterns.mdscripts/code_quality_checker.pypr_analyzer.pyreview_report_generator.py详细介绍
代码审查器
面向代码审查器的完整工具包,涵盖现代工具与最佳实践。
快速开始
主要能力
本技能通过自动化脚本提供三项核心能力:
# Script 1: Pr Analyzer
python scripts/pr_analyzer.py [options]
# Script 2: Code Quality Checker
python scripts/code_quality_checker.py [options]
# Script 3: Review Report Generator
python scripts/review_report_generator.py [options]
核心能力
1. PR 分析器
用于 PR 分析器任务的自动化工具。
特性:
- 自动化脚手架
- 内置最佳实践
- 可配置模板
- 质量检查
用法:
python scripts/pr_analyzer.py <project-path> [options]
2. 代码质量检查器
全面的分析与优化工具。
特性:
- 深度分析
- 性能指标
- 改进建议
- 自动化修复
用法:
python scripts/code_quality_checker.py <target-path> [--verbose]
3. 审查报告生成器
面向专门任务的高级工具。
特性:
- 专家级自动化
- 自定义配置
- 可即时集成
- 生产级输出
用法:
python scripts/review_report_generator.py [arguments] [options]
参考文档
代码审查清单
references/code_review_checklist.md 中提供了全面指南:
- 详细的模式与实践
- 代码示例
- 最佳实践
- 应避免的反模式
- 真实场景
编码规范
references/coding_standards.md 中提供了完整的工作流文档:
- 分步流程
- 优化策略
- 工具集成
- 性能调优
- 故障排查指南
常见反模式
references/common_antipatterns.md 中提供了技术参考指南:
- 技术栈详情
- 配置示例
- 集成模式
- 安全考量
- 可扩展性指南
技术栈
语言: TypeScript、JavaScript、Python、Go、Swift、Kotlin 前端: React、Next.js、React Native、Flutter 后端: Node.js、Express、GraphQL、REST APIs 数据库: PostgreSQL、Prisma、NeonDB、Supabase DevOps: Docker、Kubernetes、Terraform、GitHub Actions、CircleCI 云: AWS、GCP、Azure
开发工作流
1. 安装与配置
# Install dependencies
npm install
# or
pip install -r requirements.txt
# Configure environment
cp .env.example .env
2. 运行质量检查
# Use the analyzer script
python scripts/code_quality_checker.py .
# Review recommendations
# Apply fixes
3. 实施最佳实践
遵循以下文档中记录的模式与实践:
references/code_review_checklist.mdreferences/coding_standards.mdreferences/common_antipatterns.md
最佳实践摘要
代码质量
- 遵循既定模式
- 编写全面的测试
- 记录决策
- 定期审查
性能
- 优化前先测量
- 使用适当的缓存
- 优化关键路径
- 在生产环境中监控
安全
- 校验所有输入
- 使用参数化查询
- 实施适当的身份验证
- 保持依赖项更新
可维护性
- 编写清晰的代码
- 使用一致的命名
- 添加有用的注释
- 保持简单
常用命令
# Development
npm run dev
npm run build
npm run test
npm run lint
# Analysis
python scripts/code_quality_checker.py .
python scripts/review_report_generator.py --analyze
# Deployment
docker build -t app:latest .
docker-compose up -d
kubectl apply -f k8s/
故障排查
常见问题
请查看 references/common_antipatterns.md 中的全面故障排查章节。
获取帮助
- 查阅参考文档
- 查看脚本输出消息
- 查阅技术栈文档
- 查看错误日志
资源
- 模式参考:
references/code_review_checklist.md - 工作流指南:
references/coding_standards.md - 技术指南:
references/common_antipatterns.md - 工具脚本:
scripts/目录
评论
支持 Markdown