Skip to content

Keep indent indicator on empty root block scalar + comment #721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dyk1454683243-sudo wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −1
Open

Keep indent indicator on empty root block scalar + comment #721

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/stringify/stringifyString.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,10 @@ function blockString(
: type === Scalar.BLOCK_LITERAL
? true
: !lineLengthOverLimit(value, lineWidth, indent.length)
if (!value) return literal ? '|\n' : '>\n'
if (!value) {
if (ctx.forceBlockIndent) return literal ? '|2\n' : '>2\n'
return literal ? '|\n' : '>\n'
}

// determine chomping from whitespace at value end
let chomp: '' | '-' | '+'
Expand Down
14 changes: 14 additions & 0 deletions tests/doc/comments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,20 @@ describe('stringify comments', () => {
string
`)
})

test('empty root block scalar keeps indent indicator (#687)', () => {
for (const style of ['|', '>'] as const) {
const doc = YAML.parseDocument(`${style}5\n#comment`)
expect(doc.toJSON()).toBe('')
expect(doc.comment).toBe('comment')
const out = String(doc)
expect(out.startsWith(`${style}2\n`)).toBe(true)
expect(out).toContain('#comment')
const rt = YAML.parseDocument(out)
expect(rt.toJSON()).toBe('')
expect(rt.comment).toBe('comment')
}
})
})

describe('seq comments', () => {
Expand Down