Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Fix #9890] Make Colon After Comment Annotation Configurable #9899

Conversation

gregfletch
Copy link
Contributor

[Fix #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.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

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.
@@ -3150,6 +3150,10 @@ Style/CommentAnnotation:
- HACK
- REVIEW
- NOTE
EnforcedStyle: colon
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't need an enforced style for this - we can just have an boolean options like RequireColon: true.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, my initial thinking here was to leave it a bit more open with enforced style/supported styles in case somebody wanted to have a different separator, like a dash for example (i.e. TODO- some todo comment here). But I'm fine changing it to a simple boolean value indicating if a colon is required if you think that is better.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sometimes we should just keep things simple, so let's go with the boolean value.

…on to a boolean flag indicating whether or not a colon separator is required.
@bbatsov bbatsov merged commit 8333e8f into rubocop:master Jul 1, 2021
@bbatsov
Copy link
Collaborator

bbatsov commented Jul 1, 2021

Thanks!

@gregfletch gregfletch deleted the fix/gregfletch/comment-annotation-configurable branch July 1, 2021 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make enforcement of colon after comment annotation configurable
2 participants