fix: Keep inlined JSDoc comments in property conversion of svelte-migrate #15567
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.
This addresses trailing inlined JSDoc property descriptions being deleted by svelte-migrate, see #15530.
Previously:
The comment would be removed in the migrated version:
With the change in this PR it becomes the following:
The default value description in the JSDoc is still removed, but that's probably ok, as the default value is still in the declaration below.
Happy to change this if you can guide me to a different solution. The regex used here could also potentially be improved to handle more cases of (multiple) whitespace, but wanted to start a discussion first.
The style of JSDoc comments is used in Layer Cake. The components are vendored in other projects so there are lots of repos out there who use this kind of comment (e.g. GitHub search for AxisX.svelte)