Setup eslint-plugin-jsdocs #10888
Merged
Setup eslint-plugin-jsdocs #10888
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
Member
|
This LGTM. Please go ahead and merge when ready 👍 |
brophdawg11
force-pushed
the
brophdawg11/docs-eslint
branch
from
12b0f08 to
9b91b90
Compare
agionoja
pushed a commit
to agionoja/remix
that referenced
this pull request
Dec 31, 2025
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.
Stacked on #10887
Since JSDocs will be the source of our public documentation, this will help ensure that we're not forgetting to document aspects of them. Plenty of room for tweaking of the rules but this should be a good base to get started.
Anything not easily handled via the
eslintconfigs can be checked/asserted in our docs generation script with more granularity to provide another way for CI to detect missing docs.The code changes in here are mostly just a find/replace for
@return -> @returnsto align on the canonical JSDoc tag (we were about half and half across the repo).