name: 代码审查员 description: 全面的代码审查技能,适用于TypeScript、JavaScript、Python、Swift、Kotlin、Go。包括自动化代码分析、最佳实践检查、安全扫描和审查清单生成。用于审查拉取请求、提供代码反馈、识别问题或确保代码质量标准。
代码审查员
为代码审查员提供的完整工具包,包含现代工具和最佳实践。
快速入门
主要能力
此技能通过自动化脚本提供三个核心能力:
# 脚本 1: 拉取请求分析器
python scripts/pr_analyzer.py [options]
# 脚本 2: 代码质量检查器
python scripts/code_quality_checker.py [options]
# 脚本 3: 审查报告生成器
python scripts/review_report_generator.py [options]
核心能力
1. 拉取请求分析器
自动化工具,用于拉取请求分析任务。
功能:
- 自动化脚手架
- 内置最佳实践
- 可配置模板
- 质量检查
用法:
python scripts/pr_analyzer.py <项目路径> [options]
2. 代码质量检查器
全面的分析和优化工具。
功能:
- 深度分析
- 性能指标
- 建议
- 自动化修复
用法:
python scripts/code_quality_checker.py <目标路径> [--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. 设置和配置
# 安装依赖
npm install
# 或
pip install -r requirements.txt
# 配置环境
cp .env.example .env
2. 运行质量检查
# 使用分析器脚本
python scripts/code_quality_checker.py .
# 审查建议
# 应用修复
3. 实施最佳实践
遵循以下文档中的模式和做法:
references/code_review_checklist.mdreferences/coding_standards.mdreferences/common_antipatterns.md
最佳实践总结
代码质量
- 遵循既定模式
- 编写全面测试
- 文档化决策
- 定期审查
性能
- 优化前先测量
- 使用适当缓存
- 优化关键路径
- 生产环境监控
安全
- 验证所有输入
- 使用参数化查询
- 实现适当认证
- 保持依赖更新
可维护性
- 编写清晰代码
- 使用一致命名
- 添加有帮助的注释
- 保持简单
常见命令
# 开发
npm run dev
npm run build
npm run test
npm run lint
# 分析
python scripts/code_quality_checker.py .
python scripts/review_report_generator.py --analyze
# 部署
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/目录