Set up ESLint for JSDoc comments #1605
Merged
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
43081j
reviewed
Feb 19, 2024
| import jsdoc from "eslint-plugin-jsdoc"; | ||
|
|
||
| export default [ | ||
| jsdoc.configs["flat/recommended"], |
There was a problem hiding this comment.
while you're in there, can you maybe also enable eslint's recommended rule set? im surprised we didn't already have eslint
if it ends up with too big of a change, you could do a PR to add eslint + recommended, then a separate one for jsdoc on top or vice versa
43081j
reviewed
Feb 19, 2024
| @@ -2116,6 +2110,13 @@ function assertOwnPropertyDescriptor (name, descriptor, msg) { | |||
| Assertion.addMethod('ownPropertyDescriptor', assertOwnPropertyDescriptor); | |||
| Assertion.addMethod('haveOwnPropertyDescriptor', assertOwnPropertyDescriptor); | |||
|
|
|||
| /** | |||
| * | |||
There was a problem hiding this comment.
maybe add a description? "Flags that the length property should be asserted in this chain"
43081j
approved these changes
Feb 19, 2024
|
lol, maybe I shouldn't have had it on auto-merge :D I'll make a follow up PR to apply some of your suggestions @43081j |
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.
I really want to explore both better typing and possible automatic generation of API docs since the JSDoc comments that exist in the codebase are of such high quality.
This PR introduces ESLint and
eslint-plugin-jsdocto start linting JSDoc comment in effort to make sure that all of the comments stay high quality as we refactor the codeThis PR can be followed up by more changes to the rules we apply as well as some explorations into API documentation and stricter type-checking.