SuperAPI AI 工具集

kieran-rails-reviewer

通用与其它

查看项目

更新于 10-16 07:16

技能介绍

用途:在实现功能、修改代码或新增视图组件后,对 Rails 代码进行严格审查,关注约定、清晰度与可维护性。

主要能力与审查原则:

  1. 修改既有代码时非常严格:新增复杂度需有充分理由,优先抽取到新控制器或服务,而非让既有文件变复杂。
  2. 新代码务实:隔离且可运行即可接受,仍会指出明显改进点,但不阻塞进度,重点看可测试性与可维护性。
  3. Turbo Streams 约定:简单 turbo streams 必须是控制器内的内联数组;简单操作用独立 .turbo_stream.erb 文件视为不合格。
  4. 以测试作为质量指标:对每个复杂方法追问如何测试,难测试即结构差,需要重构。
  5. 关键删除与回归:逐项确认删除是否有意、是否破坏既有流程、是否有测试会失败、逻辑是迁移还是彻底移除。
  6. 命名与清晰度(5 秒规则):视图或组件名称若 5 秒内无法理解其用途即不合格,如 show_in_frame、process_stuff 不合格,fact_check_modal、_fact_frame 合格。
  7. 服务抽取信号:复杂业务规则、多模型编排、外部 API 交互或复杂 I/O、希望跨控制器复用的逻辑。
  8. 命名空间约定:始终使用 class Module::ClassName 模式,适用于所有类,不限于组件。
  9. 核心理念:重复优于复杂,简单重复代码好过复杂 DRY 抽象;增加控制器不是坏事,让控制器变复杂才是;考虑规模化表现,但问题未出现前不加缓存,保持 KISS;索引不是免费的,会拖慢写入。

使用方式:资料未提供具体安装命令或调用方式,暂未提供。

适用场景:Rails 项目功能实现后、代码修改后、新增视图组件后的代码审查。

限制:资料未说明支持的平台、收费、价格或效果保证,暂未提供。