Restore ESLint warnings as errors (ignoring them for now) #4382
Conversation
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
mcmire
force-pushed
the
remove-eslint-warnings
branch
from
d025d55 to
3c84ac6
Compare
Currently, `yarn lint` produces a bunch of warnings from ESLint. These warnings were added in a previous commit that upgraded ESLint packages as a way to avoid fixing lint violations created by the upgrade. However, this causes two problems: 1. They produce a lot of noise that makes it very difficult to find true errors, especially when looking at a CI run. 2. They allow new instances of these violations to show up (because warnings don't cause `eslint` to fail). This commit removes the overrides from the ESLint config for these rules so that they go back to being errors and adds `eslint-disable` directives above the lines that cause the violations. Note that this is not intended to be a long-term solution, and in the future, we should dedicate time to either fixing the violations or explaining why ignoring them is necessary.
mcmire
force-pushed
the
remove-eslint-warnings
branch
from
3c84ac6 to
4476162
Compare
mcmire
changed the title
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
MajorLift
approved these changes
Jun 10, 2024
Contributor
MajorLift
left a comment
MajorLift
left a comment
There was a problem hiding this comment.
LGTM! Hopefully the presence of these comments nudge people towards providing an explanation when disabling lint rules in general.
In future PRs, enabling the 'prefer' rules should remove the need for some style guide entries, and no-unnecessary-type-assertion should also be helpful for minimizing redundant or silent-failure assertions. I can create a PR for those if you don't already have them planned @mcmire
Contributor
Author
|
@MajorLift I don't have plans for the changes you mention, but they sound good, so feel free to create tickets/PRs! |
rekmarks
approved these changes
Jun 10, 2024
Member
rekmarks
left a comment
rekmarks
left a comment
There was a problem hiding this comment.
My terminal thanks you for this change. 🙇
3 tasks
legobeat
pushed a commit
that referenced
this pull request
Jun 11, 2024
Currently, `yarn lint` produces a bunch of warnings from ESLint. These warnings were added in a previous commit that upgraded ESLint packages as a way to avoid fixing lint violations created by the upgrade. However, this causes two problems: 1. They produce a lot of noise that makes it very difficult to find true errors, especially when looking at a CI run. 2. They allow new instances of these violations to show up (because warnings don't cause `eslint` to fail). This commit removes the overrides from the ESLint config for these rules so that they go back to being errors and adds `eslint-disable` directives above the lines that cause the violations. Note that this is not intended to be a long-term solution, and in the future, we should dedicate time to either fixing the violations or explaining why ignoring them is necessary.
legobeat
pushed a commit
that referenced
this pull request
Jun 11, 2024
Currently, `yarn lint` produces a bunch of warnings from ESLint. These warnings were added in a previous commit that upgraded ESLint packages as a way to avoid fixing lint violations created by the upgrade. However, this causes two problems: 1. They produce a lot of noise that makes it very difficult to find true errors, especially when looking at a CI run. 2. They allow new instances of these violations to show up (because warnings don't cause `eslint` to fail). This commit removes the overrides from the ESLint config for these rules so that they go back to being errors and adds `eslint-disable` directives above the lines that cause the violations. Note that this is not intended to be a long-term solution, and in the future, we should dedicate time to either fixing the violations or explaining why ignoring them is necessary.
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.
Explanation
Currently,
yarn lintproduces a bunch of warnings from ESLint. These warnings were added in a previous commit that upgraded ESLint packages as a way to avoid fixing lint violations created by the upgrade. However, this causes two problems:eslintto fail).This commit removes the overrides from the ESLint config for these rules so that they go back to being errors and adds
eslint-disabledirectives above the lines that cause the violations. Note that this is not intended to be a long-term solution, and in the future, we should dedicate time to either fixing the violations or explaining why ignoring them is necessary.References
Fixes #4381.
Changelog
(There are no changes to functionality.)
Checklist