fix: clamp format result range to document bounds (#153)#242
Open
maruthang wants to merge 1 commit into
Open
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
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.
Summary
Fixes #153
Bug:
formatcould return aTextEditwith a range end exceeding the document length, causing downstream consumers to fail.Root Cause: The formatter used the initial full-document range (lines 0 to
MAX_VALUE) without clamping it back to actual document bounds before returning, and also returned a redundant edit when formatting produced no changes.Fix: Added a no-op optimization that returns an empty array when the formatted result equals the original text, and added defensive range clamping that limits the edit range end to the document's actual end position.
Changes
src/services/htmlFormatter.ts: Return early with[]when formatted output matches input; clamprange.endtodocument.positionAt(text.length)before constructing the returnedTextEdit.src/test/formatter.test.ts: Added 6 regression tests covering empty documents, whitespace-only, newline-only, CRLF-only,endWithNewlineon empty input, and already-formatted content — all asserting edit ranges stay within document bounds.Testing
src/test/formatter.test.tsthat verify all returned edit ranges do not exceed document length