fix(parser): panic when parsing JSDoc @satisfies with export assignments #1647
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
…ments The parser was panicking when encountering JSDoc `@satisfies` tags on module.exports statements. The issue was that KindExportAssignment and KindJSExportAssignment were incorrectly grouped with nodes that have an Initializer() method, but they actually use Expression() instead. Also added missing support for KindCommonJSExport in the Initializer() and SetInitializer() methods. Reproduction: ```javascript /** * @Satisfies {import('../types.js').SupportVersionTraceMap} */ module.exports = { zlib: zlib, 'node:zlib': { ...zlib, [READ]: { supported: ['14.13.1', '12.20.0'] }, }, }; ```
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
camc314
force-pushed
the
c/fix-export-assignment-initializer-panic
branch
from
a77e847 to
fd02030
Compare
|
To test, you'd want to make a compiler test in |
Adds a compiler test that verifies the parser doesn't panic when encountering JSDoc @Satisfies tags on module.exports statements. This test would have failed before the fix in the previous commit.
|
thanks as always @jakebailey 🙂 Before/after |
jakebailey
reviewed
Aug 29, 2025
testdata/baselines/reference/compiler/panicSatisfiesOnExportEqualsDeclaration.errors.txt
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a parser panic that occurred when encountering JSDoc @satisfies tags on module.exports statements. The issue was caused by incorrect grouping of export assignment nodes with nodes that have an Initializer() method, when they actually use Expression() instead.
- Moves KindExportAssignment and KindJSExportAssignment from the Initializer() case to the Expression() case in the JSDoc satisfies parser logic
- Adds missing support for KindCommonJSExport in the Initializer() and SetInitializer() methods
- Includes a test case to verify the fix works correctly
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| testdata/tests/cases/compiler/panicSatisfiesOnExportEqualsDeclaration.ts | Test case demonstrating JSDoc @Satisfies on module.exports |
| testdata/baselines/reference/compiler/panicSatisfiesOnExportEqualsDeclaration.types | Expected type output for the test case |
| testdata/baselines/reference/compiler/panicSatisfiesOnExportEqualsDeclaration.symbols | Expected symbol output for the test case |
| internal/parser/reparser.go | Fixes the parser logic by moving export assignments to the correct case |
| internal/ast/ast.go | Adds missing KindCommonJSExport support in Initializer methods |
testdata/tests/cases/compiler/panicSatisfiesOnExportEqualsDeclaration.ts
Show resolved
Hide resolved
jakebailey
approved these changes
Sep 3, 2025
zshannon
pushed a commit
to zshannon/typescript-go
that referenced
this pull request
Oct 6, 2025
zshannon
pushed a commit
to zshannon/typescript-go
that referenced
this pull request
Oct 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The parser was panicking when encountering JSDoc
@satisfiestags on module.exports statements. The issue was that KindExportAssignment and KindJSExportAssignment were incorrectly grouped with nodes that have an Initializer() method, but they actually use Expression() instead.Also added missing support for KindCommonJSExport in the Initializer() and SetInitializer() methods.
Reproduction:
I couldn't actually work out how to write a test for this, so would appreciate some guidance. thanks