[Fix #12296] Support Redundant*Names options for Style/ArgumentsForwarding
#12397
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 this is great, thanks. 😀 |
bbatsov
reviewed
Nov 20, 2023
config/default.yml
Outdated
| @@ -3089,7 +3089,19 @@ Style/ArgumentsForwarding: | |||
| Enabled: pending | |||
| AllowOnlyRestArgument: true | |||
| UseAnonymousForwarding: true | |||
| ForbiddenRestArgumentNames: | |||
There was a problem hiding this comment.
I think "Redundant" is probably a better word than "Forbidden" for the purpose of this cop.
koic
changed the title
Forbidden*Names options for Style/ArgumentsForwardingRedundant*Names options for Style/ArgumentsForwarding
koic
force-pushed
the
support_fobidden_options_for_style_arguments_forwarding
branch
6 times, most recently
from
5b0a7c8
to
231ce09
Compare
…mentsForwarding` Fixes rubocop#12296. This PR supports `RedundantRestArgumentNames`, `RedundantKeywordRestArgumentNames`, and `RedundantBlockArgumentNames` options for `Style/ArgumentsForwarding`. Meaningless names that are commonly used can be anonymized by default as part of the new `Redundant*Names` defaults. e.g., `*args`, `**options`, `&block`, and some argument names. Names not on this list are likely to be meaningful and are allowed by default. This approach is designed to only detect generally meaningless names without the need for users to edit the configuration for each meaningful name, with the expectation that the default settings will work well for most cases.
koic
force-pushed
the
support_fobidden_options_for_style_arguments_forwarding
branch
from
231ce09
to
9b108a4
Compare
koic
deleted the
support_fobidden_options_for_style_arguments_forwarding
branch
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.
Fixes #12296.
This PR supports
RedundantRestArgumentNames,RedundantKeywordRestArgumentNames, andRedundantBlockArgumentNamesoptions forStyle/ArgumentsForwarding.Meaningless names that are commonly used can be anonymized by default as part of the new
Redundant*Namesdefaults. e.g.,*args,**options,&block, and some argument names.Names not on this list are likely to be meaningful and are allowed by default.
This approach is designed to only detect generally meaningless names without the need for users to edit the configuration for each meaningful name, with the expectation that the default settings will work well for most cases.
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.