fix: replace incorrect jsdoc typeExpression in AST traversal #1018
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
- the typeExpression of a JSDocTypeTag is truncated due to comment syntax.
|
@domuk-k is attempting to deploy a commit to the Svelte Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
fixes #647
the typeExpression of a JSDocTypeTag is truncated due to comment syntax.
This PR addresses an issue where the typeExpression of a JSDocTypeTag was being truncated due to comment syntax (e.g., // ...) when converting JavaScript code with JSDoc to TypeScript.
It appears there is a bug in TypeScript’s parsing of the JSDoc
@typetag, where it assigns the typeExpression property incorrectly (parseJSDocTypeExpression, reproduction).In Svelte documentation, I determined that this issue can be handled without affecting other documents by using an alternative approach.
Changes
In the previous implementation, the typeExpression field in the AST node was used, but it could be incorrect when the JSDoc type tag had multiline types or contained comment expressions.
To resolve this:
• I modified the AST traversal logic to avoid using the typeExpression field directly.
• A helper function was added to correctly handle the type expression and ensure proper type information is generated.
Before submitting the PR, please make sure you do the following
feat:,fix:,chore:, ordocs:.