class RuboCop::Options
This class handles command line options.
Constants
- DEFAULT_MAXIMUM_EXCLUSION_ITEMS
- EXITING_OPTIONS
- E_STDIN_NO_PATH
Public Class Methods
new()
click to toggle source
# File lib/rubocop/options.rb, line 19 def initialize @options = {} @validator = OptionsValidator.new(@options) end
Public Instance Methods
parse(command_line_args)
click to toggle source
# File lib/rubocop/options.rb, line 24 def parse(command_line_args) args = args_from_file.concat(args_from_env).concat(command_line_args) define_options.parse!(args) @validator.validate_compatibility if @options[:stdin] # The parser will put the file name given after --stdin into # @options[:stdin]. If it did, then the args array should be empty. raise OptionArgumentError, E_STDIN_NO_PATH if args.any? # 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
Private Instance Methods
add_aliases(opts)
click to toggle source
# File lib/rubocop/options.rb, line 174 def add_aliases(opts) option(opts, '-l', '--lint') do @options[:only] ||= [] @options[:only] << 'Lint' end option(opts, '-x', '--fix-layout') do @options[:only] ||= [] @options[:only] << 'Layout' @options[:auto_correct] = true end option(opts, '--safe-auto-correct') do @options[:auto_correct] = true end end
add_auto_gen_options(opts)
click to toggle source
# File lib/rubocop/options.rb, line 105 def add_auto_gen_options(opts) option(opts, '--auto-gen-config') option(opts, '--exclude-limit COUNT') do @validator.validate_exclude_limit_option end option(opts, '--no-offense-counts') do @options[:no_offense_counts] = true end option(opts, '--auto-gen-only-exclude') option(opts, '--no-auto-gen-timestamp') do @options[:no_auto_gen_timestamp] = true end option(opts, '--init') end
add_boolean_flags(opts)
click to toggle source
# File lib/rubocop/options.rb, line 155 def add_boolean_flags(opts) option(opts, '-F', '--fail-fast') option(opts, '-C', '--cache FLAG') option(opts, '-d', '--debug') option(opts, '-D', '--[no-]display-cop-names') option(opts, '-E', '--extra-details') option(opts, '-S', '--display-style-guide') option(opts, '-a', '--auto-correct') option(opts, '--ignore-disable-comments') option(opts, '--safe') option(opts, '--[no-]color') option(opts, '-v', '--version') option(opts, '-V', '--verbose-version') option(opts, '-P', '--parallel') end
add_configuration_options(opts)
click to toggle source
# File lib/rubocop/options.rb, line 97 def add_configuration_options(opts) option(opts, '-c', '--config FILE') option(opts, '--force-exclusion') option(opts, '--ignore-parent-exclusion') option(opts, '--force-default-config') add_auto_gen_options(opts) end
add_cop_selection_csv_option(option, opts)
click to toggle source
# File lib/rubocop/options.rb, line 84 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
add_flags_with_optional_args(opts)
click to toggle source
# File lib/rubocop/options.rb, line 149 def add_flags_with_optional_args(opts) option(opts, '--show-cops [COP1,COP2,...]') do |list| @options[:show_cops] = list.nil? ? [] : list.split(',') end end
add_formatting_options(opts)
click to toggle source
# File lib/rubocop/options.rb, line 124 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
add_list_options(opts)
click to toggle source
# File lib/rubocop/options.rb, line 189 def add_list_options(opts) option(opts, '-L', '--list-target-files') end
add_only_options(opts)
click to toggle source
# File lib/rubocop/options.rb, line 78 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
add_severity_option(opts)
click to toggle source
# File lib/rubocop/options.rb, line 139 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 option(opts, '--display-only-fail-level-offenses') end
args_from_env()
click to toggle source
# File lib/rubocop/options.rb, line 54 def args_from_env Shellwords.split(ENV.fetch('RUBOCOP_OPTS', '')) end
args_from_file()
click to toggle source
# File lib/rubocop/options.rb, line 46 def args_from_file if File.exist?('.rubocop') && !File.directory?('.rubocop') File.read('.rubocop').shellsplit else [] end end
define_options()
click to toggle source
# File lib/rubocop/options.rb, line 58 def define_options OptionParser.new do |opts| opts.banner = 'Usage: rubocop [options] [file1, file2, ...]' add_list_options(opts) add_only_options(opts) add_configuration_options(opts) 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) add_aliases(opts) option(opts, '-s', '--stdin FILE') end end
long_opt_symbol(args)
click to toggle source
Finds the option in `args` starting with – and converts it to a symbol, e.g. […, '–auto-correct', …] to :auto_correct.
# File lib/rubocop/options.rb, line 206 def long_opt_symbol(args) long_opt = args.find { |arg| arg.start_with?('--') } long_opt[2..-1].sub('[no-]', '').sub(/ .*/, '') .tr('-', '_').gsub(/[\[\]]/, '').to_sym end
option(opts, *args) { |arg| ... }
click to toggle source
Sets a value in the @options hash, based on the given long option and its value, in addition to calling the block if a block is given.
# File lib/rubocop/options.rb, line 195 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