Update formatters to output [Correctable] for correctable offenses.

Some cops only are able to correct in specific situations, but it is unclear from the output which offenses are auto-correctable and which aren't. This adds a tag to the output for offenses which are correctable but not corrected yet.

Author: dvandersluis

changelog/change_update_formatters_to_output_correctable.md

@@ -0,0 +1 @@
+* [#9187](https://github.com/rubocop-hq/rubocop/pull/9187): Update formatters to output `[Correctable]` for correctable offenses. ([@dvandersluis][])

lib/rubocop/formatter/emacs_style_formatter.rb

@@ -27,6 +27,8 @@ def message(offense)
             "[Todo] #{offense.message}"
           elsif offense.corrected?
             "[Corrected] #{offense.message}"
+          elsif offense.correctable?
+            "[Correctable] #{offense.message}"
           else
             offense.message
           end

lib/rubocop/formatter/simple_text_formatter.rb

@@ -90,6 +90,8 @@ def message(offense)
             green('[Todo] ')
           elsif offense.corrected?
             green('[Corrected] ')
+          elsif offense.correctable?
+            yellow('[Correctable] ')
           else
             ''
           end

lib/rubocop/formatter/tap_formatter.rb

@@ -71,6 +71,8 @@ def message(offense)
             '[Todo] '
           elsif offense.corrected?
             '[Corrected] '
+          elsif offense.correctable?
+            '[Correctable] '
           else
             ''
           end

spec/rubocop/cli/cli_auto_gen_config_spec.rb

@@ -921,7 +921,7 @@ def a; end
                   ])
       expect(cli.run(%w[--format emacs])).to eq(1)
       expect($stdout.string).to eq(
-        "#{abs('example.rb')}:3:9: C: Style/RegexpLiteral: Use `%r` " \
+        "#{abs('example.rb')}:3:9: C: [Correctable] Style/RegexpLiteral: Use `%r` " \
         "around regular expression.\n"
       )
       expect(cli.run(['--auto-gen-config'])).to eq(0)

spec/rubocop/cli/cli_autocorrect_spec.rb

@@ -1406,9 +1406,9 @@ def self.some_method(foo, bar: 1)
     expect(IO.read('example.rb')).to eq(corrected)
     expect($stdout.string).to eq(<<~RESULT)
       == example.rb ==
-      C:  1:  8: Style/BlockDelimiters: Prefer {...} over do...end for single-line blocks.
-      C:  2: 34: Style/Semicolon: Do not use semicolons to terminate expressions.
-      W:  3: 27: Lint/UnusedMethodArgument: Unused method argument - bar.
+      C:  1:  8: [Correctable] Style/BlockDelimiters: Prefer {...} over do...end for single-line blocks.
+      C:  2: 34: [Correctable] Style/Semicolon: Do not use semicolons to terminate expressions.
+      W:  3: 27: [Correctable] Lint/UnusedMethodArgument: Unused method argument - bar.
 
       1 file inspected, 3 offenses detected, 3 more offenses can be corrected with `rubocop -A`
     RESULT

spec/rubocop/cli/cli_options_spec.rb

@@ -79,7 +79,7 @@
         .to eq(<<~RESULT)
           == example.rb ==
           C:  1:  1: Layout/EndOfLine: Carriage return character detected.
-          C:  1:  1: Style/FrozenStringLiteralComment: Missing frozen string literal comment.
+          C:  1:  1: [Correctable] Style/FrozenStringLiteralComment: Missing frozen string literal comment.
 
           1 file inspected, 2 offenses detected, 1 offense auto-correctable
       RESULT
@@ -143,7 +143,7 @@ def and_with_args
     expect($stdout.string)
       .to eq <<~RESULT
         == example.rb ==
-        C:  3:  6: Layout/TrailingWhitespace: Trailing whitespace detected.
+        C:  3:  6: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected.
 
         1 file inspected, 1 offense detected, 1 offense auto-correctable
     RESULT
@@ -170,11 +170,11 @@ def and_with_args
     aggregate_failures('CLI output') do
       expect(cli.run(['--format', 'emacs', 'example.rb'])).to eq(1)
       expect($stdout.string)
-        .to eq(["#{abs('example.rb')}:3:6: W: Lint/AmbiguousOperator: " \
+        .to eq(["#{abs('example.rb')}:3:6: W: [Correctable] Lint/AmbiguousOperator: " \
                 'Ambiguous splat operator. Parenthesize the method arguments ' \
                 "if it's surely a splat operator, or add a whitespace to the " \
                 'right of the `*` if it should be a multiplication.',
-                "#{abs('example.rb')}:4:1: C: Style/OneLineConditional: " \
+                "#{abs('example.rb')}:4:1: C: [Correctable] Style/OneLineConditional: " \
                 'Favor the ternary operator (`?:`) or multi-line constructs over ' \
                 'single-line `if/then/else/end` constructs.',
                 ''].join("\n"))
@@ -226,7 +226,7 @@ def and_with_args
       # should get 2 offenses reported.
       expect($stdout.string).to eq(<<~RESULT)
         #{abs('example.rb')}:7:121: C: Layout/LineLength: Line is too long. [132/120]
-        #{abs('example.rb')}:9:5: C: Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+        #{abs('example.rb')}:9:5: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
       RESULT
     end
 
@@ -313,9 +313,9 @@ def and_with_args
       # 2 real cops were disabled, and 1 that was incorrect
       # 2 real cops was enabled, but only 1 had been disabled correctly
       expect($stdout.string).to eq(<<~RESULT)
-        #{abs('example.rb')}:8:21: W: Lint/RedundantCopEnableDirective: Unnecessary enabling of Layout/LineLength.
+        #{abs('example.rb')}:8:21: W: [Correctable] Lint/RedundantCopEnableDirective: Unnecessary enabling of Layout/LineLength.
         #{abs('example.rb')}:9:121: C: Layout/LineLength: Line is too long. [132/120]
-        #{abs('example.rb')}:11:5: C: Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+        #{abs('example.rb')}:11:5: C: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
       RESULT
     end
 
@@ -355,9 +355,9 @@ def and_with_args
         OUTPUT
         expect($stdout.string)
           .to eq(<<~RESULT)
-            #{abs('example.rb')}:3:150: C: Migration/DepartmentName: Department name is missing.
+            #{abs('example.rb')}:3:150: C: [Correctable] Migration/DepartmentName: Department name is missing.
             #{abs('example.rb')}:4:121: C: Layout/LineLength: Line is too long. [130/120]
-            #{abs('example.rb')}:5:28: C: Migration/DepartmentName: Department name is missing.
+            #{abs('example.rb')}:5:28: C: [Correctable] Migration/DepartmentName: Department name is missing.
         RESULT
       end
     end
@@ -377,9 +377,9 @@ def and_with_args
         expect($stderr.string).to eq('')
         expect($stdout.string).to eq(<<~RESULT)
           #{abs('example.rb')}:3:121: C: Layout/LineLength: Line is too long. [130/120]
-          #{abs('example.rb')}:4:1: W: Lint/RedundantCopDisableDirective: Unnecessary disabling of all cops.
-          #{abs('example.rb')}:5:12: W: Lint/RedundantCopDisableDirective: Unnecessary disabling of `Layout/LineLength`, `Metrics/ClassLength`.
-          #{abs('example.rb')}:6:8: W: Lint/RedundantCopDisableDirective: Unnecessary disabling of all cops.
+          #{abs('example.rb')}:4:1: W: [Correctable] Lint/RedundantCopDisableDirective: Unnecessary disabling of all cops.
+          #{abs('example.rb')}:5:12: W: [Correctable] Lint/RedundantCopDisableDirective: Unnecessary disabling of `Layout/LineLength`, `Metrics/ClassLength`.
+          #{abs('example.rb')}:6:8: W: [Correctable] Lint/RedundantCopDisableDirective: Unnecessary disabling of all cops.
         RESULT
       end
 
@@ -744,8 +744,8 @@ def meow_at_4am?
           expect($stdout.string)
             .to eq(<<~RESULT)
               == example.rb ==
-              C:  9:  3: Layout/IndentationWidth: Use 2 (not 0) spaces for indented_internal_methods indentation.
-              C: 15:  3: Layout/IndentationWidth: Use 2 (not 0) spaces for indented_internal_methods indentation.
+              C:  9:  3: [Correctable] Layout/IndentationWidth: Use 2 (not 0) spaces for indented_internal_methods indentation.
+              C: 15:  3: [Correctable] Layout/IndentationWidth: Use 2 (not 0) spaces for indented_internal_methods indentation.
 
               1 file inspected, 2 offenses detected, 2 offenses auto-correctable
           RESULT
@@ -834,7 +834,7 @@ def meow_at_4am?
           expect($stdout.string)
             .to eq(<<~RESULT)
               == example.rb ==
-              C:  3:  6: Layout/TrailingWhitespace: Trailing whitespace detected.
+              C:  3:  6: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected.
 
               1 file inspected, 1 offense detected, 1 offense auto-correctable
             RESULT
@@ -872,9 +872,9 @@ def meow_at_4am?
       expect(cli.run(%w[--format simple])).to eq(1)
       expect($stdout.string).to eq(<<~RESULT)
         == dir/example2.rb ==
-        C:  3:  6: Trailing whitespace detected.
+        C:  3:  6: [Correctable] Trailing whitespace detected.
         == example1.rb ==
-        C:  3:  6: Layout/TrailingWhitespace: Trailing whitespace detected.
+        C:  3:  6: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected.
 
         2 files inspected, 2 offenses detected, 2 offenses auto-correctable
       RESULT
@@ -898,9 +898,9 @@ def meow_at_4am?
       expect(cli.run(%w[--format simple])).to eq(1)
       expect($stdout.string).to eq(<<~RESULT)
         == dir/example2.rb ==
-        C:  3:  6: Layout/TrailingWhitespace: Trailing whitespace detected. (#{url})
+        C:  3:  6: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected. (#{url})
         == example1.rb ==
-        C:  3:  6: Layout/TrailingWhitespace: Trailing whitespace detected.
+        C:  3:  6: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected.
 
         2 files inspected, 2 offenses detected, 2 offenses auto-correctable
       RESULT
@@ -1048,7 +1048,7 @@ def meow_at_4am?
       expect(cli.run(%w[--format simple .])).to eq(1)
       expect($stdout.string).to eq(<<~RESULT)
         == special.dsl ==
-        C:  3:  9: Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
+        C:  3:  9: [Correctable] Style/StringLiterals: Prefer single-quoted strings when you don't need string interpolation or special symbols.
 
         1 file inspected, 1 offense detected, 1 offense auto-correctable
       RESULT
@@ -1088,7 +1088,7 @@ def meow_at_4am?
       expect($stdout.string)
         .to eq(<<~RESULT)
           == example1.rb ==
-          C:  3:  7: Layout/TrailingWhitespace: Trailing whitespace detected.
+          C:  3:  7: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected.
 
           1 file inspected, 1 offense detected, 1 offense auto-correctable
         RESULT
@@ -1111,7 +1111,7 @@ def meow_at_4am?
         expect($stdout.string)
           .to eq(<<~RESULT)
             == example1.rb ==
-            C:  3:  7: Layout/TrailingWhitespace: Trailing whitespace detected.
+            C:  3:  7: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected.
 
             1 file inspected, 1 offense detected, 1 offense auto-correctable
           RESULT
@@ -1169,9 +1169,9 @@ def meow_at_4am?
       cli.run(['--format', 'simple', '-c', 'rubocop.yml', 'example1.rb'])
       expect($stdout.string).to eq(<<~RESULT)
         == example1.rb ==
-        C:  3:  6: Style/PercentLiteralDelimiters: %w-literals should be delimited by [ and ].
-        C:  4:  6: Style/PercentLiteralDelimiters: %q-literals should be delimited by ( and ).
-        C:  4:  6: Style/RedundantPercentQ: Use %q only for strings that contain both single quotes and double quotes.
+        C:  3:  6: [Correctable] Style/PercentLiteralDelimiters: %w-literals should be delimited by [ and ].
+        C:  4:  6: [Correctable] Style/PercentLiteralDelimiters: %q-literals should be delimited by ( and ).
+        C:  4:  6: [Correctable] Style/RedundantPercentQ: Use %q only for strings that contain both single quotes and double quotes.
 
         1 file inspected, 3 offenses detected, 3 offenses auto-correctable
       RESULT
@@ -1201,8 +1201,8 @@ def meow_at_4am?
       expect($stdout.string)
         .to eq(<<~RESULT)
           == example1.rb ==
-          C:  1:  5: Style/CollectionMethods: Prefer find_all over select.
-          C:  1: 26: Style/CollectionMethods: Prefer map over collect.
+          C:  1:  5: [Correctable] Style/CollectionMethods: Prefer find_all over select.
+          C:  1: 26: [Correctable] Style/CollectionMethods: Prefer map over collect.
 
           1 file inspected, 2 offenses detected, 2 offenses auto-correctable
         RESULT
@@ -1227,7 +1227,7 @@ def meow_at_4am?
                         '-c', 'rubocop.yml', 'example1.rb'])
       expect($stdout.string).to eq(<<~RESULT)
         == example1.rb ==
-        C:  3:  1: Style/IfUnlessModifier: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
+        C:  3:  1: [Correctable] Style/IfUnlessModifier: Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
 
         1 file inspected, 1 offense detected, 1 offense auto-correctable
       RESULT
@@ -1250,7 +1250,7 @@ def meow_at_4am?
       expect($stdout.string)
         .to eq(<<~RESULT)
           == example_src/example1.rb ==
-          C:  3:  7: Layout/TrailingWhitespace: Trailing whitespace detected.
+          C:  3:  7: [Correctable] Layout/TrailingWhitespace: Trailing whitespace detected.
 
           1 file inspected, 1 offense detected, 1 offense auto-correctable
         RESULT

spec/rubocop/cli_spec.rb

@@ -95,7 +95,7 @@
     end
 
     context 'when the offense is not corrected' do
-      let(:status) { :uncorrected }
+      let(:status) { :unsupported }
 
       it 'prints message as-is' do
         formatter.report_file(file, [offense])
@@ -104,6 +104,16 @@
       end
     end
 
+    context 'when the offense is correctable' do
+      let(:status) { :uncorrected }
+
+      it 'prints message as-is' do
+        formatter.report_file(file, [offense])
+        expect(output.string)
+          .to include(': [Correctable] This is a message.')
+      end
+    end
+
     context 'when the offense is automatically corrected' do
       let(:status) { :corrected }
 

spec/rubocop/formatter/clang_style_formatter_spec.rb

@@ -94,7 +94,7 @@
       it 'strips newlines out of the error message' do
         formatter.file_finished(file, [offense])
         expect(output.string).to eq(
-          '/path/to/file:1:1: E: unmatched close parenthesis: /    ' \
+          '/path/to/file:1:1: E: [Correctable] unmatched close parenthesis: /    ' \
           "world # Some comment containing a ) /\n"
         )
       end

spec/rubocop/formatter/emacs_style_formatter_spec.rb

@@ -153,13 +153,13 @@ def offense_with_severity(severity)
         expect(output.string).to include(<<~OUTPUT)
           Offenses:
 
-          lib/rubocop.rb:2:3: C: foo
+          lib/rubocop.rb:2:3: C: [Correctable] foo
           This is line 2.
             ^
-          exe/rubocop:5:2: E: bar
+          exe/rubocop:5:2: E: [Correctable] bar
           This is line 5.
            ^
-          exe/rubocop:6:1: C: foo
+          exe/rubocop:6:1: C: [Correctable] foo
           This is line 6.
           ^
         OUTPUT

spec/rubocop/formatter/progress_formatter_spec.rb

@@ -55,14 +55,23 @@
     end
 
     context 'when the offense is not corrected' do
-      let(:status) { :uncorrected }
+      let(:status) { :unsupported }
 
       it 'prints message as-is' do
         expect(output.string)
           .to include(': This is a message with colored text.')
       end
     end
 
+    context 'when the offense is correctable' do
+      let(:status) { :uncorrected }
+
+      it 'prints message as-is' do
+        expect(output.string)
+          .to include(': [Correctable] This is a message with colored text.')
+      end
+    end
+
     context 'when the offense is automatically corrected' do
       let(:status) { :corrected }
 

spec/rubocop/formatter/quiet_formatter_spec.rb

@@ -55,14 +55,23 @@
     end
 
     context 'when the offense is not corrected' do
-      let(:status) { :uncorrected }
+      let(:status) { :unsupported }
 
       it 'prints message as-is' do
         expect(output.string)
           .to include(': This is a message with colored text.')
       end
     end
 
+    context 'when the offense is correctable' do
+      let(:status) { :uncorrected }
+
+      it 'prints message as-is' do
+        expect(output.string)
+          .to include(': [Correctable] This is a message with colored text.')
+      end
+    end
+
     context 'when the offense is automatically corrected' do
       let(:status) { :corrected }
 

spec/rubocop/formatter/simple_text_formatter_spec.rb

@@ -114,15 +114,15 @@
         expect(output.string).to include(<<~OUTPUT)
           1..3
           not ok 1 - lib/rubocop.rb
-          # lib/rubocop.rb:2:3: C: foo
+          # lib/rubocop.rb:2:3: C: [Correctable] foo
           # This is line 2.
           #   ^
           ok 2 - spec/spec_helper.rb
           not ok 3 - exe/rubocop
-          # exe/rubocop:5:2: E: bar
+          # exe/rubocop:5:2: E: [Correctable] bar
           # This is line 5.
           #  ^
-          # exe/rubocop:6:1: C: foo
+          # exe/rubocop:6:1: C: [Correctable] foo
           # This is line 6.
           # ^
         OUTPUT