fix: Use the lineWidth option for line breaking in flow collections (#522)

no92 · web-flow · commit 9a8aa0d28eff · 2024-02-15T13:26:38.000+02:00
This should address issues #288 and #507.
diff --git a/src/stringify/stringifyCollection.ts b/src/stringify/stringifyCollection.ts
@@ -148,7 +148,7 @@ function stringifyFlowCollection(
   } else {
     if (!reqNewline) {
       const len = lines.reduce((sum, line) => sum + line.length + 2, 2)
-      reqNewline = len > Collection.maxFlowStringSingleLineLength
+      reqNewline = ctx.options.lineWidth > 0 && len > ctx.options.lineWidth
     }
     if (reqNewline) {
       str = start
diff --git a/tests/doc/stringify.ts b/tests/doc/stringify.ts
@@ -616,7 +616,7 @@ describe('scalar styles', () => {
   y,
   n
 ]\n`
-    expect(String(doc)).toBe(str)
+    expect(doc.toString({ lineWidth: 1 })).toBe(str)
     expect(YAML.parse(str)).toEqual([
       true,
       false,
@@ -868,6 +868,36 @@ describe('indentSeq: false', () => {
   })
 })
 
+describe('lineWidth', () => {
+  const doc = YAML.parseDocument(
+    "[ 'Sed', 'ut', 'perspiciatis', 'unde', 'omnis', 'iste', 'natus', 'error', 'sit', 'voluptatem', 'accusantium', 'doloremque', 'laudantium,', 'totam' ]"
+  )
+
+  test('limit to 80 with overlong flow collection', () => {
+    expect(doc.toString({lineWidth: 80})).toBe(`[
+  'Sed',
+  'ut',
+  'perspiciatis',
+  'unde',
+  'omnis',
+  'iste',
+  'natus',
+  'error',
+  'sit',
+  'voluptatem',
+  'accusantium',
+  'doloremque',
+  'laudantium,',
+  'totam'
+]
+`)
+  })
+
+  test('limit > flow collection length', () => {
+    expect(doc.toString({lineWidth: 162})).toBe("[ 'Sed', 'ut', 'perspiciatis', 'unde', 'omnis', 'iste', 'natus', 'error', 'sit', 'voluptatem', 'accusantium', 'doloremque', 'laudantium,', 'totam' ]\n")
+  })
+})
+
 describe('collectionStyle', () => {
   test('collectionStyle: undefined', () => {
     const doc = new YAML.Document<YAML.YAMLMap, false>({ foo: ['bar'] })

Original file line number	Diff line number	Diff line change
`@@ -148,7 +148,7 @@ function stringifyFlowCollection(`
`148`	`148`	`} else {`
`149`	`149`	`if (!reqNewline) {`
`150`	`150`	`const len = lines.reduce((sum, line) => sum + line.length + 2, 2)`
`151`		`- reqNewline = len > Collection.maxFlowStringSingleLineLength`
	`151`	`+ reqNewline = ctx.options.lineWidth > 0 && len > ctx.options.lineWidth`
`152`	`152`	`}`
`153`	`153`	`if (reqNewline) {`
`154`	`154`	`str = start`