feat!: disallow multiple configuration comments for same rule #18157
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
mdjermanovic
added
core
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
💯 |
nzakas
reviewed
Feb 29, 2024
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
I have updated the message. |
nzakas
approved these changes
Mar 1, 2024
1 task
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.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[x] Add something to the core
[ ] Other, please explain:
Fixes #18132
What changes did you make? (Give an overview)
Updated code that processes
/*eslint*/comments (both in flat and eslintrc modes) to check if the rule has already been configured by another comment. In that case, the previous comment still applies, while the duplicate is reported as a lint error.Is there anything you'd like reviewers to focus on?
This doesn't cover cases where a rule appears multiple times in the same comment. Configuration comments are parsed by
levn(with a fallback to JSON parsing), which allows duplicate keys in objects and just returns the last entry. Detecting these duplicates would probably require another tool or custom parsing. I think these cases are much less important than the cases with multiple comments.