Class: RuboCop::RSpec::ConfigFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/rubocop/rspec/config_formatter.rb

Overview

Builds a YAML config file from two config hashes

Constant Summary collapse

EXTENSION_ROOT_DEPARTMENT = 
%r{^RSpec/}.freeze
COP_DOC_BASE_URL = 
'https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/'

Instance Method Summary collapse

Constructor Details

#initialize(config, descriptions) ⇒ ConfigFormatter

Returns a new instance of ConfigFormatter.



12
13
14
15
 
# File 'lib/rubocop/rspec/config_formatter.rb', line 12

def initialize(config, descriptions)
  @config       = config
  @descriptions = descriptions
end

Instance Method Details

#dump ⇒ Object 



17
18
19
20
21
22
 
# File 'lib/rubocop/rspec/config_formatter.rb', line 17

def dump
  YAML.dump(unified_config)
    .gsub(%r{^\w+/}, "\n\\0")   # Add an extra newline before each cop.
    .gsub(/^(\s+)- /, '\1  - ') # Add 2 spaces before each array element.
    .gsub('"~"', '~')           # Don't quote tilde, YAML's null value.
end