/
options.rb
598 lines (515 loc) · 25.4 KB
/
options.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# frozen_string_literal: true
require 'optparse'
require 'shellwords'
module RuboCop
class IncorrectCopNameError < StandardError; end
class OptionArgumentError < StandardError; end
# This class handles command line options.
# @api private
class Options
E_STDIN_NO_PATH = '-s/--stdin requires exactly one path, relative to the ' \
'root of the project. RuboCop will use this path to determine which ' \
'cops are enabled (via eg. Include/Exclude), and so that certain cops ' \
'like Naming/FileName can be checked.'
EXITING_OPTIONS = %i[version verbose_version show_cops show_docs_url].freeze
DEFAULT_MAXIMUM_EXCLUSION_ITEMS = 15
def initialize
@options = {}
@validator = OptionsValidator.new(@options)
end
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
def args_from_file
if File.exist?('.rubocop') && !File.directory?('.rubocop')
File.read('.rubocop').shellsplit
else
[]
end
end
def args_from_env
Shellwords.split(ENV.fetch('RUBOCOP_OPTS', ''))
end
def define_options
OptionParser.new do |opts|
opts.banner = rainbow.wrap('Usage: rubocop [options] [file1, file2, ...]').bright
add_check_options(opts)
add_cache_options(opts)
add_server_options(opts)
add_output_options(opts)
add_autocorrection_options(opts)
add_config_generation_options(opts)
add_additional_modes(opts)
add_general_options(opts)
end
end
def add_check_options(opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
section(opts, 'Basic Options') do
option(opts, '-l', '--lint') do
@options[:only] ||= []
@options[:only] << 'Lint'
end
option(opts, '-x', '--fix-layout') do
@options[:only] ||= []
@options[:only] << 'Layout'
@options[:autocorrect] = true
end
option(opts, '--safe')
add_cop_selection_csv_option('except', opts)
add_cop_selection_csv_option('only', opts)
option(opts, '--only-guide-cops')
option(opts, '-F', '--fail-fast')
option(opts, '--disable-pending-cops')
option(opts, '--enable-pending-cops')
option(opts, '--ignore-disable-comments')
option(opts, '--force-exclusion')
option(opts, '--only-recognized-file-types')
option(opts, '--ignore-parent-exclusion')
option(opts, '--ignore-unrecognized-cops')
option(opts, '--force-default-config')
option(opts, '-s', '--stdin FILE')
option(opts, '-P', '--[no-]parallel')
add_severity_option(opts)
end
end
def add_output_options(opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
section(opts, 'Output Options') do
option(opts, '-f', '--format FORMATTER') do |key|
@options[:formatters] ||= []
@options[:formatters] << [key]
end
option(opts, '-D', '--[no-]display-cop-names')
option(opts, '-E', '--extra-details')
option(opts, '-S', '--display-style-guide')
option(opts, '-o', '--out FILE') do |path|
if @options[:formatters]
@options[:formatters].last << path
else
@options[:output_path] = path
end
end
option(opts, '--stderr')
option(opts, '--display-time')
option(opts, '--display-only-failed')
option(opts, '--display-only-fail-level-offenses')
option(opts, '--display-only-correctable')
option(opts, '--display-only-safe-correctable')
end
end
# rubocop:todo Naming/InclusiveLanguage
# the autocorrect command-line arguments map to the autocorrect @options values like so:
# :fix_layout :autocorrect :safe_autocorrect :autocorrect_all
# -x, --fix-layout true true - -
# -a, --auto-correct - true true -
# --safe-auto-correct - true true -
# -A, --auto-correct-all - true - true
def add_autocorrection_options(opts) # rubocop:disable Metrics/MethodLength
section(opts, 'Autocorrection') do
option(opts, '-a', '--autocorrect') { @options[:safe_autocorrect] = true }
option(opts, '--auto-correct') do
handle_deprecated_option('--auto-correct', '--autocorrect')
@options[:safe_autocorrect] = true
end
option(opts, '--safe-auto-correct') do
handle_deprecated_option('--safe-auto-correct', '--autocorrect')
@options[:safe_autocorrect] = true
end
option(opts, '-A', '--autocorrect-all') { @options[:autocorrect] = true }
option(opts, '--auto-correct-all') do
handle_deprecated_option('--auto-correct-all', '--autocorrect-all')
@options[:autocorrect] = true
end
option(opts, '--disable-uncorrectable')
end
end
# rubocop:enable Naming/InclusiveLanguage
def add_config_generation_options(opts)
section(opts, 'Config Generation') do
option(opts, '--auto-gen-config')
option(opts, '--regenerate-todo') do
@options.replace(ConfigRegeneration.new.options.merge(@options))
end
option(opts, '--exclude-limit COUNT') { @validator.validate_exclude_limit_option }
option(opts, '--[no-]offense-counts')
option(opts, '--[no-]auto-gen-only-exclude')
option(opts, '--[no-]auto-gen-timestamp')
end
end
def add_cop_selection_csv_option(option, opts)
option(opts, "--#{option} [COP1,COP2,...]") do |list|
unless list
message = "--#{option} argument should be [COP1,COP2,...]."
raise OptionArgumentError, message
end
@options[:"#{option}"] = list.empty? ? [''] : list.split(',')
end
end
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 add_cache_options(opts)
section(opts, 'Caching') do
option(opts, '-C', '--cache FLAG')
option(opts, '--cache-root DIR') { @validator.validate_cache_enabled_for_cache_root }
end
end
def add_server_options(opts)
section(opts, 'Server Options') do
option(opts, '--[no-]server')
option(opts, '--restart-server')
option(opts, '--start-server')
option(opts, '--stop-server')
option(opts, '--server-status')
end
end
def add_additional_modes(opts)
section(opts, 'Additional Modes') do
option(opts, '-L', '--list-target-files')
option(opts, '--show-cops [COP1,COP2,...]') do |list|
@options[:show_cops] = list.nil? ? [] : list.split(',')
end
option(opts, '--show-docs-url [COP1,COP2,...]') do |list|
@options[:show_docs_url] = list.nil? ? [] : list.split(',')
end
end
end
def add_general_options(opts)
section(opts, 'General Options') do
option(opts, '--init')
option(opts, '-c', '--config FILE')
option(opts, '-d', '--debug')
option(opts, '-r', '--require FILE') { |f| require_feature(f) }
option(opts, '--[no-]color')
option(opts, '-v', '--version')
option(opts, '-V', '--verbose-version')
end
end
def handle_deprecated_option(old_option, new_option)
warn rainbow.wrap("#{old_option} is deprecated; use #{new_option} instead.").yellow
@options[long_opt_symbol([new_option])] = @options.delete(long_opt_symbol([old_option]))
end
def rainbow
@rainbow ||= begin
rainbow = Rainbow.new
rainbow.enabled = false if ARGV.include?('--no-color')
rainbow
end
end
# Creates a section of options in order to separate them visually when
# using `--help`.
def section(opts, heading, &_block)
heading = rainbow.wrap(heading).bright
opts.separator("\n#{heading}:\n")
yield
end
# 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.
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
# Finds the option in `args` starting with -- and converts it to a symbol,
# e.g. [..., '--autocorrect', ...] to :autocorrect.
def long_opt_symbol(args)
long_opt = args.find { |arg| arg.start_with?('--') }
long_opt[2..].sub('[no-]', '').sub(/ .*/, '').tr('-', '_').gsub(/[\[\]]/, '').to_sym
end
def require_feature(file)
# If any features were added on the CLI from `--require`,
# add them to the config.
ConfigLoader.add_loaded_features(file)
require file
end
end
# Validates option arguments and the options' compatibility with each other.
# @api private
class OptionsValidator
class << self
SYNTAX_DEPARTMENTS = %w[Syntax Lint/Syntax].freeze
private_constant :SYNTAX_DEPARTMENTS
# Cop name validation must be done later than option parsing, so it's not
# called from within Options.
def validate_cop_list(names)
return unless names
cop_names = Cop::Registry.global.names
departments = Cop::Registry.global.departments.map(&:to_s)
names.each do |name|
next if cop_names.include?(name)
next if departments.include?(name)
next if SYNTAX_DEPARTMENTS.include?(name)
raise IncorrectCopNameError, format_message_from(name, cop_names)
end
end
private
def format_message_from(name, cop_names)
message = 'Unrecognized cop or department: %<name>s.'
message_with_candidate = "%<message>s\nDid you mean? %<candidate>s"
corrections = NameSimilarity.find_similar_names(name, cop_names)
if corrections.empty?
format(message, name: name)
else
format(message_with_candidate, message: format(message, name: name),
candidate: corrections.join(', '))
end
end
end
def initialize(options)
@options = options
end
def validate_cop_options
%i[only except].each { |opt| OptionsValidator.validate_cop_list(@options[opt]) }
end
# rubocop:disable Metrics/AbcSize
def validate_compatibility # rubocop:disable Metrics/MethodLength
if only_includes_redundant_disable?
raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot be used with --only.'
end
raise OptionArgumentError, 'Syntax checking cannot be turned off.' if except_syntax?
unless boolean_or_empty_cache?
raise OptionArgumentError, '-C/--cache argument must be true or false'
end
if display_only_fail_level_offenses_with_autocorrect?
raise OptionArgumentError, '--autocorrect cannot be used with ' \
'--display-only-fail-level-offenses.'
end
validate_auto_gen_config
validate_autocorrect
validate_display_only_failed
validate_display_only_failed_and_display_only_correctable
validate_display_only_correctable_and_autocorrect
disable_parallel_when_invalid_option_combo
return if incompatible_options.size <= 1
raise OptionArgumentError, "Incompatible cli options: #{incompatible_options.inspect}"
end
# rubocop:enable Metrics/AbcSize
def validate_auto_gen_config
return if @options.key?(:auto_gen_config)
message = '--%<flag>s can only be used together with --auto-gen-config.'
%i[exclude_limit offense_counts auto_gen_timestamp
auto_gen_only_exclude].each do |option|
if @options.key?(option)
raise OptionArgumentError, format(message, flag: option.to_s.tr('_', '-'))
end
end
end
def validate_display_only_failed
return unless @options.key?(:display_only_failed)
return if @options[:format] == 'junit'
raise OptionArgumentError,
format('--display-only-failed can only be used together with --format junit.')
end
def validate_display_only_correctable_and_autocorrect
return unless @options.key?(:autocorrect)
return if !@options.key?(:display_only_correctable) &&
!@options.key?(:display_only_safe_correctable)
raise OptionArgumentError,
'--autocorrect cannot be used with --display-only-[safe-]correctable.'
end
def validate_display_only_failed_and_display_only_correctable
return unless @options.key?(:display_only_failed)
return if !@options.key?(:display_only_correctable) &&
!@options.key?(:display_only_safe_correctable)
raise OptionArgumentError,
format('--display-only-failed cannot be used together with other display options.')
end
def validate_autocorrect
return if @options.key?(:autocorrect)
return unless @options.key?(:disable_uncorrectable)
raise OptionArgumentError,
format('--disable-uncorrectable can only be used together with --autocorrect.')
end
def disable_parallel_when_invalid_option_combo
return unless @options.key?(:parallel)
invalid_flags = invalid_arguments_for_parallel
return if invalid_flags.empty?
@options.delete(:parallel)
puts '-P/--parallel is being ignored because ' \
"it is not compatible with #{invalid_flags.join(', ')}."
end
def invalid_arguments_for_parallel
[('--auto-gen-config' if @options.key?(:auto_gen_config)),
('-F/--fail-fast' if @options.key?(:fail_fast)),
('-x/--fix-layout' if @options.key?(:fix_layout)),
('-a/--autocorrect' if @options.key?(:safe_autocorrect)),
('-A/--autocorrect-all' if @options.key?(:autocorrect_all)),
('--cache false' if @options > { cache: 'false' })].compact
end
def only_includes_redundant_disable?
@options.key?(:only) &&
(@options[:only] & %w[Lint/RedundantCopDisableDirective RedundantCopDisableDirective]).any?
end
def display_only_fail_level_offenses_with_autocorrect?
@options.key?(:display_only_fail_level_offenses) && @options.key?(:autocorrect)
end
def except_syntax?
@options.key?(:except) && (@options[:except] & %w[Lint/Syntax Syntax]).any?
end
def boolean_or_empty_cache?
!@options.key?(:cache) || %w[true false].include?(@options[:cache])
end
def incompatible_options
@incompatible_options ||= @options.keys & Options::EXITING_OPTIONS
end
def validate_exclude_limit_option
return if /^\d+$/.match?(@options[:exclude_limit])
# Emulate OptionParser's behavior to make failures consistent regardless
# of option order.
raise OptionParser::MissingArgument
end
def validate_cache_enabled_for_cache_root
return unless @options[:cache] == 'false'
raise OptionArgumentError, '--cache-root cannot be used with --cache false'
end
end
# This module contains help texts for command line options.
# @api private
module OptionsHelp
MAX_EXCL = RuboCop::Options::DEFAULT_MAXIMUM_EXCLUSION_ITEMS.to_s
FORMATTER_OPTION_LIST = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS.keys
TEXT = {
only: 'Run only the given cop(s).',
only_guide_cops: ['Run only cops for rules that link to a',
'style guide.'],
except: 'Exclude the given cop(s).',
require: 'Require Ruby file.',
config: 'Specify configuration file.',
auto_gen_config: ['Generate a configuration file acting as a',
'TODO list.'],
regenerate_todo: ['Regenerate the TODO configuration file using',
'the last configuration. If there is no existing',
'TODO file, acts like --auto-gen-config.'],
offense_counts: ['Include offense counts in configuration',
'file generated by --auto-gen-config.',
'Default is true.'],
auto_gen_timestamp:
['Include the date and time when the --auto-gen-config',
'was run in the file it generates. Default is true.'],
auto_gen_only_exclude:
['Generate only Exclude parameters and not Max',
'when running --auto-gen-config, except if the',
'number of files with offenses is bigger than',
'exclude-limit. Default is false.'],
exclude_limit: ['Set the limit for how many files to explicitly exclude.',
'If there are more files than the limit, the cop will',
"be disabled instead. Default is #{MAX_EXCL}."],
disable_uncorrectable: ['Used with --autocorrect to annotate any',
'offenses that do not support autocorrect',
'with `rubocop:todo` comments.'],
force_exclusion: ['Any files excluded by `Exclude` in configuration',
'files will be excluded, even if given explicitly',
'as arguments.'],
only_recognized_file_types: ['Inspect files given on the command line only if',
'they are listed in `AllCops/Include` parameters',
'of user configuration or default configuration.'],
ignore_disable_comments: ['Run cops even when they are disabled locally',
'by a `rubocop:disable` directive.'],
ignore_parent_exclusion: ['Prevent from inheriting `AllCops/Exclude` from',
'parent folders.'],
ignore_unrecognized_cops: ['Ignore unrecognized cops or departments in the config.'],
force_default_config: ['Use default configuration even if configuration',
'files are present in the directory tree.'],
format: ['Choose an output formatter. This option',
'can be specified multiple times to enable',
'multiple formatters at the same time.',
*FORMATTER_OPTION_LIST.map do |item|
" #{item}#{' (default)' if item == '[p]rogress'}"
end,
' custom formatter class name'],
out: ['Write output to a file instead of STDOUT.',
'This option applies to the previously',
'specified --format, or the default format',
'if no format is specified.'],
fail_level: ['Minimum severity for exit with error code.',
' [A] autocorrect',
' [I] info',
' [R] refactor',
' [C] convention',
' [W] warning',
' [E] error',
' [F] fatal'],
display_time: 'Display elapsed time in seconds.',
display_only_failed: ['Only output offense messages. Omit passing',
'cops. Only valid for --format junit.'],
display_only_fail_level_offenses:
['Only output offense messages at',
'the specified --fail-level or above'],
display_only_correctable: ['Only output correctable offense messages.'],
display_only_safe_correctable: ['Only output safe-correctable offense messages',
'when combined with --display-only-correctable.'],
show_cops: ['Shows the given cops, or all cops by',
'default, and their configurations for the',
'current directory.'],
show_docs_url: ['Display url to documentation for the given',
'cops, or base url by default.'],
fail_fast: ['Inspect files in order of modification',
'time and stop after the first file',
'containing offenses.'],
cache: ["Use result caching (FLAG=true) or don't",
'(FLAG=false), default determined by',
'configuration parameter AllCops: UseCache.'],
cache_root: ['Set the cache root directory.',
'Takes precedence over the configuration',
'parameter AllCops: CacheRootDirectory and',
'the $RUBOCOP_CACHE_ROOT environment variable.'],
debug: 'Display debug info.',
display_cop_names: ['Display cop names in offense messages.',
'Default is true.'],
disable_pending_cops: 'Run without pending cops.',
display_style_guide: 'Display style guide URLs in offense messages.',
enable_pending_cops: 'Run with pending cops.',
extra_details: 'Display extra details in offense messages.',
lint: 'Run only lint cops.',
safe: 'Run only safe cops.',
stderr: ['Write all output to stderr except for the',
'autocorrected source. This is especially useful',
'when combined with --autocorrect and --stdin.'],
list_target_files: 'List all files RuboCop will inspect.',
autocorrect: 'Autocorrect offenses (only when it\'s safe).',
auto_correct: '(same, deprecated)',
safe_auto_correct: '(same, deprecated)',
autocorrect_all: 'Autocorrect offenses (safe and unsafe).',
auto_correct_all: '(same, deprecated)',
fix_layout: 'Run only layout cops, with autocorrect on.',
color: 'Force color output on or off.',
version: 'Display version.',
verbose_version: 'Display verbose version.',
parallel: ['Use available CPUs to execute inspection in',
'parallel. Default is true.'],
stdin: ['Pipe source from STDIN, using FILE in offense',
'reports. This is useful for editor integration.'],
init: 'Generate a .rubocop.yml file in the current directory.',
server: ['If a server process has not been started yet, start',
'the server process and execute inspection with server.',
'Default is false.',
'You can specify the server host and port with the',
'$RUBOCOP_SERVER_HOST and the $RUBOCOP_SERVER_PORT',
'environment variables.'],
restart_server: 'Restart server process.',
start_server: 'Start server process.',
stop_server: 'Stop server process.',
server_status: 'Show server status.'
}.freeze
end
end