Add new Lint/RequireRangeParentheses cop
#10792
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
koic
force-pushed
the
add_new_lint_require_range_parentheses_cop
branch
4 times, most recently
from
a263284
to
9911536
Compare
bbatsov
reviewed
Jul 7, 2022
| # Checks that the range is enclosed in parentheses when the end of the range is line break. | ||
| # | ||
| # NOTE: The following is maybe intended for `(42..)`. But, compatible is `42..do_something`. | ||
| # So, this cop does not provide autocollection because it is left to user. |
There was a problem hiding this comment.
autocollection -> autocorrection
bbatsov
reviewed
Jul 7, 2022
| # | ||
| # @example | ||
| # | ||
| # # bad |
There was a problem hiding this comment.
You might also add comments for the bad/good cases so it's clearer what they mean.
bbatsov
reviewed
Jul 7, 2022
| module RuboCop | ||
| module Cop | ||
| module Lint | ||
| # Checks that the range is enclosed in parentheses when the end of the range is line break. |
There was a problem hiding this comment.
that a range literal
is at a line break
bbatsov
reviewed
Jul 7, 2022
| # 42 | ||
| # | ||
| class RequireRangeParentheses < Base | ||
| MSG = 'Use parentheses in the endless range to avoid confusion about precedence.' |
There was a problem hiding this comment.
Wrap the endless range literal %s to avoid precedence ambiguity.
koic
force-pushed
the
add_new_lint_require_range_parentheses_cop
branch
from
9911536
to
8aed359
Compare
|
I've updated this PR. Thank you! |
## Context It emulates the following Ruby warning. ```console % cat example.rb 1... 2 ``` ```consle % ruby example.rb example.rb:1: warning: ... at EOL, should be parenthesized? ``` So, this cop will detect case like rubocop#10789. ## Summary It checks that a range literal is enclosed in parentheses when the end of the range is at a line break. ### example ```ruby # bad - Represents `(1..42)`, not endless range. 1.. 42 # good - It's incompatible, but your intentions when using endless range may be: (1..) 42 # good 1..42 # good (1..42) # good (1.. 42) ``` NOTE: The following is maybe intended for `(42..)`. But, compatible is `42..do_something`. So, this cop does not provide autocorrection because it is left to user. ```ruby case condition when 42.. do_something end ```
koic
force-pushed
the
add_new_lint_require_range_parentheses_cop
branch
from
8aed359
to
3c96b2a
Compare
koic
added a commit
that referenced
this pull request
Jul 7, 2022
Follow up #10792. This commit suppresses the following `Lint/RequireRangeParentheses` offense. ```console % bundle exec rubocop (snip) Offenses: lib/rubocop/cop/mixin/percent_array.rb:101:13: W: Lint/RequireRangeParentheses: Wrap the endless range literal node.children[0].location.expression.end_pos... to avoid precedence ambiguity. node.children[0].location.expression.end_pos... ... ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 1 file inspected, 1 offense detected ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
It emulates the following Ruby warning.
So, this cop will detect case like #10789.
Summary
It checks that a range literal is enclosed in parentheses when the end of the range is at a line break.
example
NOTE: The following is maybe intended for
(42..). But, compatible is42..do_something. So, this cop does not provide autocorrection because it is left to user.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.