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 #6630] Updated Style/CommentAnnotation to be able to handle multiword keyword phrases #10039

Merged
merged 2 commits into from Aug 25, 2021

Conversation

dvandersluis
Copy link
Member

This change first refactors AnnotationComment to be an actual class modeling an annotation comment, and then updates it to be able to handle multiword phrases as annotation keywords.

With config:

Style/CommentAnnotation:
  Keywords:
    - TODO
    - TODO LATER
test.rb:1:1: C: [Correctable] Style/CommentAnnotation: Annotation keywords like TODO LATER should be all upper case, followed by a colon, and a space, then a note describing the problem.
# TODO LATER blah blah blah
  ^^^^^^^^^^^

Fixes #6630.


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.

@bbatsov
Copy link
Collaborator

bbatsov commented Aug 25, 2021

Great work!

@dvandersluis dvandersluis deleted the issue/6630 branch September 14, 2021 16:04
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.

properly fix group of annotation keywords (for example "TODO HACK lorem ipsum") [will be wontfixed by bot]
2 participants