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 Emacs style frozen string literal comment check #6380

Merged
merged 1 commit into from Oct 12, 2018

Conversation

y-yagi
Copy link
Contributor

@y-yagi y-yagi commented Oct 12, 2018

Emacs style + hyphen delimited frozen literal comment(-*- frozen-string-literal: true -*-) is a valid comment.
Ref: https://github.com/ruby/ruby/blob/0cb0835581de93f97861e38acf6ae338ad49f8b5/test/ruby/test_literal.rb#L149-L152

But RuboCop does not recognize this comment currently. This fix allows using that format comment.


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 rake default. It executes all tests and RuboCop for itself, and generates the documentation.

@koic
Copy link
Member

koic commented Oct 12, 2018

Good catch! I think that it is good to write changelog entry about this change.

@y-yagi y-yagi force-pushed the fix_frozen_string_literal_check branch 2 times, most recently from c730b70 to 450c356 Compare October 12, 2018 03:46
Emacs style + hyphen delimited frozen literal comment(`-*- frozen-string-literal: true -*-`)
is a valid comment.
Ref: https://github.com/ruby/ruby/blob/0cb0835581de93f97861e38acf6ae338ad49f8b5/test/ruby/test_literal.rb#L149-L152

But RuboCop does not recognize this comment currently.
This fix allows using that format comment.
@y-yagi y-yagi force-pushed the fix_frozen_string_literal_check branch from 450c356 to 946a26b Compare October 12, 2018 03:48
@y-yagi
Copy link
Contributor Author

y-yagi commented Oct 12, 2018

Thanks for your review. I added a changelog entry.

@koic koic merged commit 8a8d448 into rubocop:master Oct 12, 2018
@koic
Copy link
Member

koic commented Oct 12, 2018

Thanks!

@y-yagi y-yagi deleted the fix_frozen_string_literal_check branch October 12, 2018 06:29
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