fix: Quote top-level map keys containing document markers (fixes #431)

eemeli · Dec 30, 2022 · c8551eb · c8551eb
1 parent 3576408
commit c8551eb
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 4 deletions.
diff --git a/src/stringify/stringifyString.ts b/src/stringify/stringifyString.ts
@@ -266,7 +266,7 @@ function plainString(
   onChompKeep?: () => void
 ) {
   const { type, value } = item
-  const { actualString, implicitKey, indent, inFlow } = ctx
+  const { actualString, implicitKey, indent, indentStep, inFlow } = ctx
   if (
     (implicitKey && /[\n[\]{},]/.test(value)) ||
     (inFlow && /[[\]{},]/.test(value))
@@ -298,9 +298,13 @@ function plainString(
     // Where allowed & type not set explicitly, prefer block style for multiline strings
     return blockString(item, ctx, onComment, onChompKeep)
   }
-  if (indent === '' && containsDocumentMarker(value)) {
-    ctx.forceBlockIndent = true
-    return blockString(item, ctx, onComment, onChompKeep)
+  if (containsDocumentMarker(value)) {
+    if (indent === '') {
+      ctx.forceBlockIndent = true
+      return blockString(item, ctx, onComment, onChompKeep)
+    } else if (implicitKey && indent === indentStep) {
+      return quotedString(value, ctx)
+    }
   }
   const str = value.replace(/\n+/g, `$&\n${indent}`)
   // Verify that output will be parsed as a string, as e.g. plain numbers and

diff --git a/tests/doc/stringify.js b/tests/doc/stringify.js
@@ -1118,6 +1118,20 @@ describe('Document markers in top-level scalars', () => {
   })
 })
 
+describe('Document markers in top-level map keys (eemeli/yaml#431)', () => {
+  test('---', () => {
+    const str = YAML.stringify({ '--- x': 42 })
+    expect(str).toBe('"--- x": 42\n')
+    expect(YAML.parse(str)).toEqual({ '--- x': 42 })
+  })
+
+  test('...', () => {
+    const str = YAML.stringify({ '... x': 42 })
+    expect(str).toBe('"... x": 42\n')
+    expect(YAML.parse(str)).toEqual({ '... x': 42 })
+  })
+})
+
 describe('undefined values', () => {
   test('undefined', () => {
     expect(YAML.stringify(undefined)).toBeUndefined()