Packages: Update eslint jsdoc plugin #65859
Draft
+884
−1,577
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
sirreal
requested review from
gziolo,
ntwb,
nerrad and
ajitbohra
as code owners
sirreal
added
[Type] Enhancement
|
Size Change: +335 B (+0.02%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
|
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. |
sirreal
force-pushed
the
upgrade/eslint-jsdoc-plugin
branch
from
42e615f to
ff9f5bb
Compare
sirreal
force-pushed
the
upgrade/eslint-jsdoc-plugin
branch
from
ff9f5bb to
d005274
Compare
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?
The eslint-plugin-jsdoc is out of date and would be beneficial to update.
Notably, a new JSDoc tag
@importfor importing types is supported by TypeScript. The JSDoc eslint package should be updated to allow the syntax.It looks like this:
It has the advantage of working like a regular type import that can be re-used, without the disadvantage of the
@typedeftag that implicitly re-exports the type.The upgrade package includes several breaking changes that should not correspond to a breaking update for Gutenbergs eslint plugin package:
Why?
See above.
Testing Instructions
CI should pass.
You can try using
@importJSDoc tag locally (like in the example above) and it should produce no lint errors.