SuperAPI AI 工具集

code-reviewer

编程与开发

查看项目

更新于 10-14 07:26

技能介绍

code-reviewer 是一个用于代码审查的技能工具包,提供现代工具与最佳实践支持。根据资料,它覆盖的语言包括 TypeScript、JavaScript、Python、Swift、Kotlin、Go;涉及的前端技术包括 React、Next.js、React Native、Flutter,后端包括 Node.js、Express、GraphQL、REST APIs,数据库包括 PostgreSQL、Prisma、NeonDB、Supabase,并涉及 Docker、Kubernetes、Terraform、GitHub Actions、CircleCI 以及 AWS、GCP、Azure 等云平台。

主要能力 该技能通过自动化脚本提供三项核心能力:

  1. PR 分析器:命令为 python scripts/pr_analyzer.py [options],也支持 python scripts/pr_analyzer.py <project-path> [options]。资料列出的功能包括自动化脚手架、内置最佳实践、可配置模板与质量检查。
  2. 代码质量检查器:命令为 python scripts/code_quality_checker.py [options],也支持 python scripts/code_quality_checker.py <target-path> [--verbose]。资料列出的功能包括深度分析、性能指标、建议与自动化修复。
  3. 审查报告生成器:命令为 python scripts/review_report_generator.py [options],资料中亦写作 python scripts/review_report_generator.py [arguments] [options],以及 python scripts/review_report_generator.py --analyze。资料列出的功能包括专家级自动化、自定义配置、可集成与生产级输出。

使用方式 安装依赖时,可使用 npm install 或 pip install -r requirements.txt;配置环境可使用 cp .env.example .env。运行质量检查可使用 python scripts/code_quality_checker.py .,随后查看建议并应用修复。常见开发命令包括 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/code_review_checklist.md(代码审查清单,包含详细模式与实践、代码示例、最佳实践、需避免的反模式、真实场景);references/coding_standards.md(编码标准,包含分步流程、优化策略、工具集成、性能调优、故障排查指南);references/common_antipatterns.md(常见反模式,包含技术栈细节、配置示例、集成模式、安全考量、可扩展性指南)。

最佳实践要点 资料中列出的最佳实践总结包括:代码质量方面遵循既定模式、编写完整测试、记录决策、定期审查;性能方面先测量再优化、使用合适的缓存、优化关键路径、在生产环境监控;安全方面校验所有输入、使用参数化查询、实现适当的认证、保持依赖更新;可维护性方面编写清晰代码、使用一致命名、添加有用的注释、保持简单。

故障排查 资料提示遇到常见问题时可查看 references/common_antipatterns.md 中的故障排查部分;获取帮助的方式包括查阅参考文档、查看脚本输出信息、查阅技术栈文档、查看错误日志。

限制与补充 资料未提供该技能的许可证、维护者、版本号、发布时间与具体支持范围边界等信息,暂未提供。资料中部分脚本用法仅给出占位参数(如 [arguments] [options]),未说明完整参数含义,暂未提供详细说明。