fix: keep indentation indicator on empty block scalar before a comment - #711
Open
abhijeet117 wants to merge 1 commit into
Open
fix: keep indentation indicator on empty block scalar before a comment#711abhijeet117 wants to merge 1 commit into
abhijeet117 wants to merge 1 commit into
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
For an empty block scalar followed by a document-level comment,
toString()emitted a bare|header without an indentation indicator. When that output is re-parsed, the comment line is no longer outside the block scalar and becomes part of the scalar value, soparseDocument('|5\n#comment\n').toString()does not round-trip: the comment turns into string data. The empty-value branch now emits an indentation indicator when a top-level comment follows, matching the protection that non-empty block scalars get through forced content indentation.Testing
Reproduced with
parseDocument('|5\n#comment\n'): the firsttoString()output reparsed as the value"\n\n#comment\n"with no comment. Added a round-trip regression test intests/doc/comments.tsthat fails without this change. Full vitest suite passes (3387 tests), eslint and tsc are clean.Checklist