preserve jsdoc prop descriptions in declaration emit#4250
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR improves JSDoc comment preservation/formatting in generated declarations by reusing a shared JSDoc text-extraction helper and by restoring lost property documentation when nodes were reparsed.
Changes:
- Preserve (partial) JSDoc descriptions for reparsed property signature declarations during declaration transformation.
- Add a scanner utility to extract/trims JSDoc comment text consistently (including
{@link ...}nodes). - Update hover handling to use the shared JSDoc comment text utility and refresh affected baseline outputs.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/transformers/declarations/transform.go | Adds preservePartialJsDoc and applies it to property signature transformations. |
| internal/scanner/utilities.go | Introduces GetTextOfJSDocComment for consistent JSDoc text extraction and trimming. |
| internal/ls/hover.go | Replaces local JSDoc comment concatenation with the shared scanner utility. |
| testdata/baselines/reference/submodule*/conformance/*.js | Updates baselines to reflect newly preserved property JSDoc blocks. |
| testdata/baselines/reference/submoduleAccepted/conformance/*.js.diff | Updates “accepted” baselines to reflect new emitted output. |
jakebailey
reviewed
Jun 9, 2026
jakebailey
approved these changes
Jun 9, 2026
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.
Fixes #4235