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

Use Ruby 2.7 parser for rake documentation_syntax_check #7645

Conversation

koic
Copy link
Member

@koic koic commented Jan 12, 2020

Summary

This PR uses Ruby 2.7 parser for rake documentation_syntax_check.
With this change, example code written using Ruby 2.7 syntax can be analyzed.

Other infromation

The following error occurs in Lint/CircularArgumentReference example code when Ruby 2.7 parser is used.

% bundle exec rake documentation_syntax_check
Files:         474
Modules:        83 (   11 undocumented)
Classes:       438 (    3 undocumented)
Constants:     631 (  621 undocumented)
Attributes:     31 (    0 undocumented)
Methods:      1081 (  960 undocumented)
 29.55% documented
 lib/rubocop/cop/lint/circular_argument_reference.rb: Syntax Error in an
 example. circular argument reference pie
 lib/rubocop/cop/lint/circular_argument_reference.rb: Syntax Error in an
 example. circular argument reference dry_ingredients

The error is avoided by using Ruby 2.6 parser for Lint/CircularArgumentReference example code as a workaround.


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.

## Summary

This PR uses Ruby 2.7 parser for `rake documentation_syntax_check`.
With this change, example code written using Ruby 2.7 syntax can be
analyzed.

## Other infromation

The following error occurs in `Lint/CircularArgumentReference` example code
when Ruby 2.7 parser is used.

```consle
% bundle exec rake documentation_syntax_check
Files:         474
Modules:        83 (   11 undocumented)
Classes:       438 (    3 undocumented)
Constants:     631 (  621 undocumented)
Attributes:     31 (    0 undocumented)
Methods:      1081 (  960 undocumented)
 29.55% documented
 lib/rubocop/cop/lint/circular_argument_reference.rb: Syntax Error in an
 example. circular argument reference pie
 lib/rubocop/cop/lint/circular_argument_reference.rb: Syntax Error in an
 example. circular argument reference dry_ingredients
```

The error is avoided by using Ruby 2.6 parser for
`Lint/CircularArgumentReference` example code as a workaround.
@bbatsov bbatsov merged commit ba67295 into rubocop:master Jan 12, 2020
@bbatsov
Copy link
Collaborator

bbatsov commented Jan 12, 2020

Thanks!

@koic koic deleted the use_ruby_2_7_parser_for_rake_documentation_syntax_check branch January 12, 2020 16:41
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