fix(parser): handle multiple JSDoc blocks gracefully#2611
Open
SSDWGG wants to merge 1 commit into
Open
Conversation
When a declaration is preceded by multiple JSDoc blocks (e.g. a copyright header and a documentation block), ts-morph may throw "expected at most 1 jsDoc node". Wrap getJsDocs() in a try-catch to gracefully return undefined instead of aborting generation. Fixes airtasker#1080
timdawborn
reviewed
May 17, 2026
Contributor
timdawborn
left a comment
There was a problem hiding this comment.
Looks good to me.
Can you please add a unit test for this behavioural change though.
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
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.
Summary
Fixes #1080 — when multiple JSDoc blocks precede a single TypeScript declaration (e.g. a copyright header
/** ... */followed by a documentation block/** ... */),getJsDoc()now catches the error from ts-morph and returnsundefinedgracefully instead of aborting generation entirely.Reproducer
Running
spot generatepreviously threw:Error: expected at most 1 jsDoc node, got 2Change
Wrapped
node.getJsDocs()in a try-catch withingetJsDoc(). When ts-morph rejects a node with multiple JSDoc blocks, the function returnsundefined(no description) rather than crashing the generation.Why this is safe
getJsDoc()returnsundefined, callers already handle it — they leave thedescriptionfield emptyChecklist
undefinedreturn