[Fix rubocop#10410] Improve help string for --fail-level CLI option

Closes rubocop#10410
tejasbubane · Feb 17, 2022 · 82e5d09 · 82e5d09
1 parent 9f82e0f
commit 82e5d09
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/changelog/change_improve_fail_level_help_string.md b/changelog/change_improve_fail_level_help_string.md
@@ -0,0 +1 @@
+* [#10410](https://github.com/rubocop/rubocop/issues/10410): Improve help string for `--fail-level` CLI option. ([@tejasbubane][])
diff --git a/lib/rubocop/options.rb b/lib/rubocop/options.rb
@@ -467,8 +467,14 @@ module OptionsHelp
                                          'This option applies to the previously',
                                          'specified --format, or the default format',
                                          'if no format is specified.'],
-      fail_level:                       ['Minimum severity (A/I/R/C/W/E/F) for exit',
-                                         'with error code.'],
+      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.'],

diff --git a/spec/rubocop/options_spec.rb b/spec/rubocop/options_spec.rb
@@ -64,8 +64,14 @@ def abs(path)
                                                reports. This is useful for editor integration.
               -P, --[no-]parallel              Use available CPUs to execute inspection in
                                                parallel. Default is true.
-                  --fail-level SEVERITY        Minimum severity (A/I/R/C/W/E/F) for exit
-                                               with error code.
+                  --fail-level SEVERITY        Minimum severity for exit with error code.
+                                               [A] autocorrect
+                                               [I] info
+                                               [R] refactor
+                                               [C] convention
+                                               [W] warning
+                                               [E] error
+                                               [F] fatal
 
           Caching:
               -C, --cache FLAG                 Use result caching (FLAG=true) or don't