SuperAPI AI 工具集

code-review

编程与开发

查看项目

更新于 10-16 03:30

技能介绍

用途

Code Review 是一个专注于 Rails 应用的代码审查技能。它的核心定位是:只读取、分析和报告发现的问题,绝不修改代码。当用户需要代码审查、质量分析、架构审计时可以使用。

主要能力

该技能从多个维度评估 Rails 代码:

  • SOLID 原则:检查单一职责原则违规、硬编码条件分支、缺少依赖注入等问题。
  • Rails 反模式:识别臃肿的控制器与模型、N+1 查询、回调地狱等。
  • 安全:检查批量赋值、SQL 注入、XSS、缺少授权等问题。
  • 性能:检查缺失索引、低效查询、可缓存的机会。
  • 代码质量:检查命名、重复代码、方法复杂度、测试覆盖率。

使用方式

审查流程分为三步。

第一步,运行静态分析:

bin/brakeman
bin/bundler-audit
bundle exec rubocop

第二步,分析代码,对照上述重点领域进行阅读和评估。

第三步,输出结构化反馈,格式为:

  • Summary:高层概览
  • Critical Issues (P0):安全、数据丢失风险
  • Major Issues (P1):性能、可维护性
  • Minor Issues (P2-P3):风格、改进建议
  • Positive Observations:做得好的地方

每个问题按“What → Where (file:line) → Why → How(代码示例)”的结构给出。

技能还提供了反模式示例,例如将臃肿控制器重构为服务对象、用预加载解决 N+1 查询、补充授权检查等。

审查清单

  • 安全:Brakeman 无告警
  • 依赖:Bundler Audit 无告警
  • 风格:符合 RuboCop
  • 架构:遵循 SOLID 原则
  • 模式:无臃肿控制器/模型
  • 性能:无 N+1,索引齐全
  • 授权:使用 Pundit 策略
  • 测试:覆盖率充分
  • 命名:清晰一致
  • 重复:无重复代码

适用场景

适用于 Rails 项目的代码审查、质量分析、架构审计,以及需要按优先级获得结构化改进建议的场景。

限制

该技能只做只读分析,不会修改代码。关于收费、价格、平台支持范围等信息,资料中暂未提供。