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

Allow a trailing comment as a description comment for Bundler/GemComment #8537

Conversation

pocke
Copy link
Collaborator

@pocke pocke commented Aug 14, 2020

Bundler/GemComment cop isn't aware of trailing comments.

# Gemfile


# It is allowed

# It's a cool gem
gem 'rubocop'


# But it is not allowed

gem 'rubocop' # It's a cool gem

This pull request fixes this problem.

The cop will allow both of the gem 'rubocop' with this patch.

Cause

In gem 'rubocop' # It's a cool gem, the comment isn't associated with the send node. Actually it is associated with the str node, which is 'rubocop'.
So we need to check comments for descendants.


Before submitting the PR make sure the following are checked:

  • 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.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

@pocke pocke force-pushed the Allow-a-trailing-comment-as-a-description-comment-for-Bundler/GemComment branch from cbe6e31 to 5518c1e Compare August 14, 2020 03:29
@koic koic merged commit 59fd34b into rubocop:master Aug 14, 2020
@koic
Copy link
Member

koic commented Aug 14, 2020

Good catch 👍

@pocke pocke deleted the Allow-a-trailing-comment-as-a-description-comment-for-Bundler/GemComment branch August 14, 2020 06: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.

None yet

2 participants