class RuboCop::Options

This class handles command line options.

def add_boolean_flags(opts) # rubocop:disable Metrics/MethodLength

rubocop:disable Metrics/MethodLength
def add_boolean_flags(opts) # rubocop:disable Metrics/MethodLength
  option(opts, '-F', '--fail-fast')
  option(opts, '-C', '--cache FLAG')
  option(opts, '-d', '--debug')
  option(opts, '-D', '--display-cop-names')
  option(opts, '-E', '--extra-details')
  option(opts, '-S', '--display-style-guide')
  option(opts, '-R', '--rails')
  option(opts, '-l', '--lint') do
    @options[:only] ||= []
    @options[:only] << 'Lint'
  end
  option(opts, '-a', '--auto-correct')
  option(opts, '--[no-]color') { |c| @options[:color] = c }
  option(opts, '-v', '--version')
  option(opts, '-V', '--verbose-version')
  option(opts, '-P', '--parallel')
end

def add_configuration_options(opts, args)

def add_configuration_options(opts, args)
  option(opts, '-c', '--config FILE')
  option(opts, '--auto-gen-config')
  option(opts, '--exclude-limit COUNT') do
    @validator.validate_exclude_limit_option(args)
  end
  option(opts, '--force-exclusion')
  option(opts, '--force-default-config')
  option(opts, '--no-offense-counts') do
    @options[:no_offense_counts] = true
  end
end

def add_cop_selection_csv_option(option, opts)

def add_cop_selection_csv_option(option, opts)
  option(opts, "--#{option} [COP1,COP2,...]") do |list|
    @options[:"#{option}"] =
      if list.empty?
        ['']
      else
        list.split(',').map do |c|
          Cop::Cop.qualified_cop_name(c, "--#{option} option")
        end
      end
  end
end

def add_flags_with_optional_args(opts)

def add_flags_with_optional_args(opts)
  option(opts, '--show-cops [COP1,COP2,...]') do |list|
    @options[:show_cops] = list.nil? ? [] : list.split(',')
  end
end

def add_formatting_options(opts)

def add_formatting_options(opts)
  option(opts, '-f', '--format FORMATTER') do |key|
    @options[:formatters] ||= []
    @options[:formatters] << [key]
  end
  option(opts, '-o', '--out FILE') do |path|
    if @options[:formatters]
      @options[:formatters].last << path
    else
      @options[:output_path] = path
    end
  end
end

def add_list_options(opts)

def add_list_options(opts)
  option(opts, '-L', '--list-target-files')
end

def add_only_options(opts)

def add_only_options(opts)
  add_cop_selection_csv_option('except', opts)
  add_cop_selection_csv_option('only', opts)
  option(opts, '--only-guide-cops')
end

def add_severity_option(opts)

def add_severity_option(opts)
  table = RuboCop::Cop::Severity::CODE_TABLE.merge(A: :autocorrect)
  option(opts, '--fail-level SEVERITY',
         RuboCop::Cop::Severity::NAMES + [:autocorrect],
         table) do |severity|
    @options[:fail_level] = severity
  end
end

def args_from_env

def args_from_env
  Shellwords.split(ENV.fetch('RUBOCOP_OPTS', ''))
end

def args_from_file

def args_from_file
  if File.exist?('.rubocop') && !File.directory?('.rubocop')
    IO.readlines('.rubocop').map(&:strip)
  else
    []
  end
end

def define_options(args)

def define_options(args)
  OptionParser.new do |opts|
    opts.banner = 'Usage: rubocop [options] [file1, file2, ...]'
    add_list_options(opts)
    add_only_options(opts)
    add_configuration_options(opts, args)
    add_formatting_options(opts)
    option(opts, '-r', '--require FILE') { |f| require f }
    add_severity_option(opts)
    add_flags_with_optional_args(opts)
    add_boolean_flags(opts)
    option(opts, '-s', '--stdin FILE')
  end
end

def initialize

def initialize
  @options = {}
  @validator = OptionsValidator.new(@options)
end

def long_opt_symbol(args)

e.g. [..., '--auto-correct', ...] to :auto_correct.
Finds the option in `args` starting with -- and converts it to a symbol,
def long_opt_symbol(args)
  long_opt = args.find { |arg| arg.start_with?('--') }
  long_opt[2..-1].sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
end

def option(opts, *args)

value, in addition to calling the block if a block is given.
Sets a value in the @options hash, based on the given long option and its
def option(opts, *args)
  long_opt_symbol = long_opt_symbol(args)
  args += Array(OptionsHelp::TEXT[long_opt_symbol])
  opts.on(*args) do |arg|
    @options[long_opt_symbol] = arg
    yield arg if block_given?
  end
end

def parse(command_line_args)

def parse(command_line_args)
  args = args_from_file.concat(args_from_env).concat(command_line_args)
  define_options(args).parse!(args)
  # The --no-color CLI option sets `color: false` so we don't want the
  # `no_color` key, which is created automatically.
  @options.delete(:no_color)
  @validator.validate_compatibility
  if @options[:stdin]
    # The parser has put the file name given after --stdin into
    # @options[:stdin]. The args array should be empty.
    if args.any?
      raise ArgumentError, '-s/--stdin requires exactly one path.'
    end
    # We want the STDIN contents in @options[:stdin] and the file name in
    # args to simplify the rest of the processing.
    args = [@options[:stdin]]
    @options[:stdin] = $stdin.binmode.read
  end
  [@options, args]
end