chore: Update jsdoc to tolerate trailing commas #8819
Merged
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
jsdoc doesn't tolerate trailing commas in record types. This is frustrating because: - It creates larger diffs to skip trailing commas when you add new fields - It requires a style in typedefs that is the opposite of the style rules in actual code This updates our jsdoc fork (joeyparrish/jsdoc@a1e61a4) and its parser dependency "catharsis" (joeyparrish/catharsis@afcfb1c) to tolerate trailing commas when parsing typedefs. Closes shaka-project#1236
|
I’ll test and review tomorrow. Thanks @joeyparrish ! |
|
Incremental code coverage: No instrumented code was changed. |
|
I have a follow-up to add trailing commas to all the record types. |
In this PR? |
|
No, a separate PR. |
avelad
approved these changes
Jun 30, 2025
joeyparrish
added a commit
to joeyparrish/shaka-player
that referenced
this pull request
Jun 30, 2025
Now that jsdoc supports this, it will make future diffs cleaner. See shaka-project#8819
joeyparrish
added a commit
that referenced
this pull request
Jun 30, 2025
avelad
pushed a commit
that referenced
this pull request
Jul 7, 2025
jsdoc doesn't tolerate trailing commas in record types. This is frustrating because: - It creates larger diffs to skip trailing commas when you add new fields - It requires a style in typedefs that is the opposite of the style rules in actual code This updates our jsdoc fork (joeyparrish/jsdoc@a1e61a4) and its parser dependency "catharsis" (joeyparrish/catharsis@afcfb1c) to tolerate trailing commas when parsing record types. Closes #1236
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.
jsdoc doesn't tolerate trailing commas in record types. This is frustrating because:
This updates our jsdoc fork (joeyparrish/jsdoc@a1e61a4) and its parser dependency "catharsis" (joeyparrish/catharsis@afcfb1c) to tolerate trailing commas when parsing record types.
Closes #1236