Breaking: no-unused-vars reports all after-used params (fixes #9909) #10119
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
eslint-deprecated
bot
added
the
triage
platinumazure
added
bug
btmills
reviewed
Mar 30, 2018
docs/rules/no-unused-vars.md
Outdated
| @@ -150,7 +150,7 @@ console.log(secondVar); | |||
|
|
|||
| The `args` option has three settings: | |||
|
|
|||
| * `after-used` - only the last argument must be used. This allows you, for instance, to have two named parameters to a function and as long as you use the second argument, ESLint will not warn you about the first. This is the default setting. | |||
| * `after-used` - unused arguments that occur before the last used argument will not be checked, but all other arguments (including after the last used argument) will be checked. | |||
There was a problem hiding this comment.
What about this tweak?
"Unused positional arguments that occur before the last used argument will not be checked, but all named arguments and all positional arguments after the last used argument will be checked."
platinumazure
force-pushed
the
no-unused-vars-after-used
branch
from
4a3b09b
to
0e246ae
Compare
|
@btmills Rebased and pushed an extra commit with your suggested wording, please review at your convenience. Thanks! |
mysticatea
approved these changes
Apr 1, 2018
platinumazure
force-pushed
the
no-unused-vars-after-used
branch
from
0e246ae
to
ee36e76
Compare
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[x] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
See #9909.
What changes did you make? (Give an overview)
The
no-unused-varsrule was changed some time ago (likely unintentionally) to only report the last unused parameter when using theargs: "after-used"setting. This resulted in poor UX in the case of a function with multiple unused parameters after the last used parameter, because ESLint would only report one parameter, and then report another parameter after the user fixed the first reported parameter.This change simplifies the
args: "after-used"logic by using this simple algorithm to check if a parameter is "after used parameters": If there exists at least one parameter (declared after the one being examined) which has at least one reference, then the parameter being examined is not "after the last used parameter" and so it shouldn't be reported. This approach allows for multiple parameters to be reported, as needed.Is there anything you'd like reviewers to focus on?