Module: RuboCop::OptionsHelp

Defined in:

lib/rubocop/options.rb

Overview

This module contains help texts for command line options.

Constant Summary

TEXT =

{
  only:              'Run only the given cop(s).',
  require:           'Require Ruby file.',
  config:            'Specify configuration file.',
  auto_gen_config:  ['Generate a configuration file acting as a',
                     'TODO list.'],
  force_exclusion:  ['Force excluding files specified in the',
                     'configuration `Exclude` even if they are',
                     'explicitly passed as arguments.'],
  format:           ['Choose an output formatter. This option',
                     'can be specified multiple times to enable',
                     'multiple formatters at the same time.',
                     '  [p]rogress (default)',
                     '  [s]imple',
                     '  [c]lang',
                     '  [d]isabled cops via inline comments',
                     '  [fu]ubar',
                     '  [e]macs',
                     '  [j]son',
                     '  [h]tml',
                     '  [fi]les',
                     '  [o]ffenses',
                     '  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.',
  show_cops:        ['Shows the given cops, or all cops by',
                     'default, and their configurations for the',
                     'current directory.'],
  fail_fast:        ['Inspect files in order of modification',
                     'time and stop after the first file',
                     'containing offenses.'],
  debug:             'Display debug info.',
  display_cop_names: 'Display cop names in offense messages.',
  rails:             'Run extra Rails cops.',
  lint:              'Run only lint cops.',
  auto_correct:      'Auto-correct offenses.',
  no_color:          'Disable color output.',
  version:           'Display version.',
  verbose_version:   'Display verbose version.'
}