Replace no-shadow eslint rule with @typescript-eslint/no-shadow#38665
Merged
kevin940726 merged 3 commits intotrunkfrom Feb 10, 2022
Merged
Replace no-shadow eslint rule with @typescript-eslint/no-shadow#38665kevin940726 merged 3 commits intotrunkfrom
kevin940726 merged 3 commits intotrunkfrom
Conversation
|
Size Change: +62 B (0%) Total Size: 1.14 MB
ℹ️ View Unchanged
|
gziolo
reviewed
Feb 9, 2022
Member
There was a problem hiding this comment.
While it works for Gutenberg, we could also do the same instead for the ESLint plugin we expose for 3rd party projects. There is a similar case we did for another rule:
gutenberg/packages/eslint-plugin/configs/recommended.js
Lines 45 to 47 in e5f35bd
It only uses this different rule when a project has TS installed, which is true for Gutenberg.
Contributor
Author
|
Sounds good @gziolo – I just did that. |
gziolo
approved these changes
Feb 9, 2022
Member
gziolo
left a comment
There was a problem hiding this comment.
Awesome, thank you!
Let's add an entry to the CHANGELOG before merging:
https://github.com/WordPress/gutenberg/blob/trunk/packages/eslint-plugin/CHANGELOG.md
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
At the moment, declaring any typescript enum triggers the following eslint error:
You can confirm that by creating a
status.tsfile somewhere in the repo and pasting the following contents:The StackOverflow discussion reveals there is a dedicated
no-shadowrule for typescript code called@typescript-eslint/no-shadow:https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/no-shadow.md#how-to-use
And so I propose we use that rule instead.
Testing Instructions
@typescript-eslint/no-shadowcovers the same cases asno-shadowcc @gziolo @kevin940726 @youknowriad @jsnajdr