[Fix rubocop#9890]

Make the separator for the Style/CommentAnnotation cop configurable. By default, the enforced style will be the current behaviour of annotation keyword followed by a colon (`:`), and a space. A new supported style is added to only require a space following the annotation keyword.

CHANGELOG.md

@@ -5722,3 +5722,4 @@
 [@timlkelly]: https://github.com/timlkelly
 [@AirWick219]: https://github.com/AirWick219
 [@markburns]: https://github.com/markburns
+[@gregfletch]: https://github.com/gregfletch

changelog/fix_make_comment_annotation_style_configurable.md

@@ -0,0 +1 @@
+* [#9890](https://github.com/rubocop/rubocop/issues/9890): Make colon after comment annotation configurable. ([@gregfletch][])

config/default.yml

@@ -3150,6 +3150,10 @@ Style/CommentAnnotation:
     - HACK
     - REVIEW
     - NOTE
+  EnforcedStyle: colon
+  SupportedStyles:
+    - colon
+    - space
 
 Style/CommentedKeyword:
   Description: 'Do not place comments on the same line as certain keywords.'

lib/rubocop/cop/style/comment_annotation.rb

@@ -12,7 +12,7 @@ module Style
       # incorrect registering of keywords (eg. `review`) inside a paragraph as an
       # annotation.
       #
-      # @example
+      # @example EnforcedStyle: colon (default)
       #   # bad
       #   # TODO make better
       #
@@ -36,14 +36,37 @@ module Style
       #
       #   # good
       #   # OPTIMIZE: does not work
+      #
+      # @example EnforcedStyle: space
+      #   # bad
+      #   # TODO: make better
+      #
+      #   # good
+      #   # TODO make better
+      #
+      #   # bad
+      #   # fixme does not work
+      #
+      #   # good
+      #   # FIXME does not work
+      #
+      #   # bad
+      #   # Optimize does not work
+      #
+      #   # good
+      #   # OPTIMIZE does not work
       class CommentAnnotation < Base
         include AnnotationComment
+        include ConfigurableEnforcedStyle
         include RangeHelp
         extend AutoCorrector
 
-        MSG = 'Annotation keywords like `%<keyword>s` should be all ' \
-              'upper case, followed by a colon, and a space, ' \
-              'then a note describing the problem.'
+        MSG_COLON_STYLE = 'Annotation keywords like `%<keyword>s` should be all ' \
+                          'upper case, followed by a colon, and a space, ' \
+                          'then a note describing the problem.'
+        MSG_SPACE_STYLE = 'Annotation keywords like `%<keyword>s` should be all ' \
+                          'upper case, followed by a space, ' \
+                          'then a note describing the problem.'
         MISSING_NOTE = 'Annotation comment, with keyword `%<keyword>s`, is missing a note.'
 
         def on_new_investigation
@@ -63,13 +86,19 @@ def on_new_investigation
         private
 
         def register_offense(range, note, first_word)
+          message = if style == :colon
+                      MSG_COLON_STYLE
+                    else
+                      MSG_SPACE_STYLE
+                    end
+
           add_offense(
             range,
-            message: format(note ? MSG : MISSING_NOTE, keyword: first_word)
+            message: format(note ? message : MISSING_NOTE, keyword: first_word)
           ) do |corrector|
             next if note.nil?
 
-            corrector.replace(range, "#{first_word.upcase}: ")
+            correct_offense(corrector, range, first_word)
           end
         end
 
@@ -92,8 +121,26 @@ def concat_length(*args)
         end
 
         def correct_annotation?(first_word, colon, space, note)
+          return correct_colon_annotation?(first_word, colon, space, note) if style == :colon
+
+          correct_space_annotation?(first_word, colon, space, note)
+        end
+
+        def correct_colon_annotation?(first_word, colon, space, note)
           keyword?(first_word) && (colon && space && note || !colon && !note)
         end
+
+        def correct_space_annotation?(first_word, colon, space, note)
+          keyword?(first_word) && (!colon && space && note || !colon && !note)
+        end
+
+        def correct_offense(corrector, range, first_word)
+          if style == :colon
+            corrector.replace(range, "#{first_word.upcase}: ")
+          else
+            corrector.replace(range, "#{first_word.upcase} ")
+          end
+        end
       end
     end
   end