开发

此页面描述了开发 RSpec Rails 特定 Cops 时需要考虑的事项。它旨在作为对一般 RuboCop 开发文档 的补充。

创建新的 Cop

克隆仓库并运行 bundle install（如果尚未完成）。以下 Rake 任务只能在 RuboCop 项目目录本身中运行。

使用捆绑的 Rake 任务 new_cop 生成 Cop 模板

$ bundle exec rake 'new_cop[RSpecRails/CopName]'
[create] lib/rubocop/cop/rspec_rails/cop_name.rb
[create] spec/rubocop/cop/rspec_rails/cop_name_spec.rb
[modify] lib/rubocop/cop/rspec_rails_cops.rb - `require_relative 'rspec_rails/cop_name'` was injected.
[modify] A configuration for the cop is added into config/default.yml.
Do 4 steps:
  1. Modify the description of RSpecRails/CopName in config/default.yml
  2. Implement your new cop in the generated file!
  3. Add an entry about new cop to CHANGELOG.md
  4. Commit your new cop with a message such as
     e.g. "Add new `#{badge}` cop"

选择名称

使用以下规则为新的 cop 命名

  • 选择一个部门。请参阅 现有部门列表

  • 名称不言自明

  • 名称解释了 cop 检测到的违规行为，例如 ExtraSpacing

  • 名称以名词开头，而不是动词，例如 ArrayAlignment 而不是 AlignArray

  • 名称易于理解，例如 IndentationStyle 而不是 Tab

  • 名称具体，例如 DuplicateHashKey 而不是 DuplicateKey

  • 名称在可能的情况下保持中立，并在可行的情况下适应多种风格，例如 EmptyLineBeforeBegin。

  • 名称使用常用术语，例如 RedundantPercentI 而不是 RedundantPercentSymbolArray

  • 名称使用正确的术语，例如方法调用中的参数和方法签名中的参数

  • 没有符号的行称为“空行”，而不是“空白行”，例如 LeadingEmptyLines 而不是 LeadingBlankLines

  • 优先使用“冗余”而不是“不必要”，例如 RedundantSelf 而不是 UnneededSelf

请参阅 "renamed" section of config/obsoletion.yml 以获取优劣示例（旧名称在左侧，新名称在右侧）。