Fixed a formatting crash on comments inside blocks starting on first line#2793
Open
Andarist wants to merge 1 commit intomicrosoft:mainfrom
Open
Fixed a formatting crash on comments inside blocks starting on first line#2793Andarist wants to merge 1 commit intomicrosoft:mainfrom
Andarist wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a panic in the LSP formatter that occurred when formatting JavaScript/TypeScript files containing comments inside blocks that start on the first line (e.g., arrow function bodies). The panic was caused by passing a negative indentation value (-1) to strings.Repeat().
Changes:
- Added a check to prevent passing -1 indentation values to
indentTriviaItems - Added regression tests for both multiline JSDoc comments and single-line comments in the problematic scenario
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| internal/format/span.go | Added guard to check if commentIndentation is -1 before calling indentTriviaItems, preventing the panic |
| internal/format/comment_test.go | Added two regression tests verifying that formatting doesn't panic for comments inside blocks starting on first line |
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
1 participant
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 #2649