Parent

Files

Class/Module Index [+]

Quicksearch

RuboCop::Formatter::DisabledConfigFormatter

This formatter displays a YAML configuration file where all cops that detected any offenses are configured to not detect the offense.

Constants

COPS
HEADING

Attributes

config_to_allow_offenses[RW]

Public Instance Methods

file_finished(_file, offenses) click to toggle source
# File lib/rubocop/formatter/disabled_config_formatter.rb, line 24
def file_finished(_file, offenses)
  @cops_with_offenses ||= Hash.new(0)
  offenses.each { |o| @cops_with_offenses[o.cop_name] += 1 }
end
finished(_inspected_files) click to toggle source
# File lib/rubocop/formatter/disabled_config_formatter.rb, line 29
def finished(_inspected_files)
  output.puts HEADING

  # Syntax isn't a real cop and it can't be disabled.
  @cops_with_offenses.delete('Syntax')

  @cops_with_offenses.sort.each do |cop_name, offense_count|
    output.puts
    cfg = self.class.config_to_allow_offenses[cop_name]
    cfg ||= { 'Enabled' => false }
    output_cop_comments(output, cfg, cop_name, offense_count)
    output.puts "#{cop_name}:"
    cfg.each { |key, value| output.puts "  #{key}: #{value}" }
  end
  puts "Created #{output.path}."
  puts "Run `rubocop --config #{output.path}`, or"
  puts "add inherit_from: #{output.path} in a .rubocop.yml file."
end
output_cop_comments(output, cfg, cop_name, offense_count) click to toggle source
# File lib/rubocop/formatter/disabled_config_formatter.rb, line 48
def output_cop_comments(output, cfg, cop_name, offense_count)
  output.puts "# Offense count: #{offense_count}"
  if COPS[cop_name] && COPS[cop_name].first.new.support_autocorrect?
    output.puts '# Cop supports --auto-correct.'
  end

  default_cfg = RuboCop::ConfigLoader.default_configuration[cop_name]
  return unless default_cfg

  params = default_cfg.keys - %(Description Enabled) - cfg.keys
  return if params.empty?

  output.puts "# Configuration parameters: #{params.join(', ')}."
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.