Style/CommentedKeyword has different definition of disable/todo comment format #12717
Comments
jonas054
added a commit
to jonas054/rubocop
that referenced
this issue
Feb 27, 2024
…e/CommentedKeyword To make sure we don't have a different, more strict definition of what constitutes a rubocop:disable or rubocop:todo comment in the cop compared to elsewhere in the code, use the definition implemented in DirectiveComment. We also get the rubocop:enable comments included in this definition, but it's not a problem if we allow those comments in the cop, as they don't make any sense as end-of-line comments and are unlikely to occur.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This came out of the discussion in #12705.
For the inline disabling of cops in inspected code, RuboCop allows many variations of the
# rubocop:disableand# rubocop:todocomments when it comes to the use of whitespace.The
Style/CommentedKeywordcop, which reports on end-of-line comments next to certain keywords, makes exceptions for these special comments and don't report offenses for them. The problem is that the cop's definition of the comments is quite strict regarding whitespace, and it deviates from what other parts of RuboCop defines as acceptable syntax for them.Expected behavior
The same definition of
# rubocop:disableand# rubocop:todoshould be used everywhere.Actual behavior
Style/CommentedKeywordreports and corrects offenses if the spacing isn't# rubopcop:disable Dept/Cop.Steps to reproduce the problem
Run
rubocop --only Style/CommentedKeywordon the fileAn offense is reported.
RuboCop version
The text was updated successfully, but these errors were encountered: