ESLint: Change jsdoc/check-line-alignment from warn to error
#47878
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
added
[Type] Code Quality
tyxla
requested review from
gziolo,
ntwb,
nerrad and
ajitbohra
as code owners
This was referenced Feb 8, 2023
|
Size Change: 0 B Total Size: 1.32 MB ℹ️ View Unchanged
|
Mamaduka
approved these changes
Feb 8, 2023
|
Flaky tests detected in 0ea771d. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4124593300
|
|
I'm still debating with myself whether it should be only for this repository to start. On the other hand, folks can always disable this rule if that feels too much 🤔 |
I'm happy to move it to this project only if you feel strongly about it. I just think it can be helpful to everyone since it's been warning us for a while and I believe this isn't the kind of rule that should provide a warning. |
|
My only concern was the developer experience for folks who will start seeing errors after upgrading to the latest version, but since they see the warning already then maybe it isn't a big deal and aligns with how stricter rules are rolled out in other projects. Finally, it's a fixable rule, so if someone is using ESLint with this config, it's trivial to move forward. I think we are good 🚢 |
gziolo
approved these changes
Feb 8, 2023
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?
This PR changes the
jsdoc/check-line-alignmentESLint rule toerrorinstead ofwarn.Why?
We've recently been fixing a bunch of these warnings, so as suggested by @gziolo here and here it might be a good idea to promote it to
error.How?
We're increasing the severity of the rule
jsdoc/check-line-alignmentfromwarntoerror.Testing Instructions
Verify
npm run lint:jsstill works well and yields just 16 warnings.Testing Instructions for Keyboard
None
Screenshots or screencast
None