ESLint: Remove explicit react-hooks/exhaustive-deps disabling
#66461
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
tyxla
requested review from
draganescu,
adamziel,
kevin940726,
tellthemachines,
ellatrix,
ajitbohra and
nerrad
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: 0 B Total Size: 1.81 MB ℹ️ View Unchanged
|
|
Just chiming in here because I saw this
Don't necessarily agree with this. As a contributor it's already super noisy having dozens or hundreds of warnings across the whole code base. If something needs fixing it should be a proper error, or else disabled. But nobody looks at warnings, especially if there are so many of them already everywhere. You just start ignoring them completely. |
|
FWIW the main point that guides me is moving forward to allow for React Compiler to land. I'm happy to disagree here. I don't see how specifically ignoring a warning with |
|
@tyxla, can we exclude the |
Yeah @Mamaduka, we'll likely have to do it anyway. cc @jsnajdr for feedback, but I think there's no easy way around it without a major refactor. |
karthick-murugan
pushed a commit
to karthick-murugan/gutenberg
that referenced
this pull request
Nov 13, 2024
…ess#66461) Co-authored-by: tyxla <tyxla@git.wordpress.org> Co-authored-by: Mamaduka <mamaduka@git.wordpress.org>
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.
What?
I propose we remove most of those ESLint disable directives. In many of them (where available), we'll still keep the comments that explain why we're violating the rule.
Why?
Currently, we're still explicitly disabling the
react-hooks/exhaustive-depsrule in many places. This is a problem for the React Compiler, which we're aiming to introduce to Gutenberg soon - it is being disabled entirely for the file where we disable the rule in. See #61788 for more details and #66324 as a similar PR that contains some discussion about why we're doing this.Furthermore, by ignoring the rule, we don't really help with awareness. If the warning is there, there's a chance someone who sees the warning in their IDE to refactor it. When ignored, the IDE doesn't highlight it, so it may forever linger there. That's why for warnings, I see more value in having them there, rather than ignoring them.
How?
We're removing the
eslint-disabledirectives in most of the occurrences.This means those will be raised as ESLint warnings, but I'm not concerned about this - this rule is already widely disobeyed across the repository (hundreds of instances), so why should we bother with these 15-20 instances?
Testing Instructions
No testing needed, this changes just comments and lint results. Make sure all checks are green.
Testing Instructions for Keyboard
Same
Screenshots or screencast