feat: convert line break to whitespace for the description of the option (#2271)

hung-cybo · Benjamin E. Coe · web-flow · commit 4cb41dc80aaa · 2023-02-13T12:50:28.000-05:00
Co-authored-by: Benjamin E. Coe &lt;bencoe@google.com&gt;
diff --git a/lib/completion.ts b/lib/completion.ts
@@ -266,7 +266,9 @@ export class Completion implements CompletionInstance {
       const desc = descs[key] ?? descFromAlias ?? '';
       completions.push(
         dashes +
-          `${key.replace(/:/g, '\\:')}:${desc.replace('__yargsString__:', '')}`
+          `${key.replace(/:/g, '\\:')}:${desc
+            .replace('__yargsString__:', '')
+            .replace(/(\r\n|\n|\r)/gm, ' ')}`
       );
     }
   }
diff --git a/test/completion.cjs b/test/completion.cjs
@@ -1077,6 +1077,23 @@ describe('Completion', () => {
       r.logs.should.include('-B:Bar option');
     });
 
+    it('completes options with line break', () => {
+      process.env.SHELL = '/bin/zsh';
+      const r = checkUsage(
+        () =>
+          yargs(['./completion', '--get-yargs-completions', '-'])
+            .options({
+              foo: {describe: 'Foo option\nFoo option', type: 'string'},
+            })
+            .help(false)
+            .version(false)
+            .completion().argv
+      );
+
+      r.logs.should.have.length(1);
+      r.logs.should.include('--foo:Foo option Foo option');
+    });
+
     it('replaces application variable with $0 in script', () => {
       process.env.SHELL = '/bin/zsh';
       const r = checkUsage(() => yargs([]).showCompletionScript(), ['ndm']);

Original file line number	Diff line number	Diff line change
`@@ -266,7 +266,9 @@ export class Completion implements CompletionInstance {`
`266`	`266`	`const desc = descs[key] ?? descFromAlias ?? '';`
`267`	`267`	`completions.push(`
`268`	`268`	`dashes +`
`269`		- `${key.replace(/:/g, '\\:')}:${desc.replace('__yargsString__:', '')}`
	`269`	+ `${key.replace(/:/g, '\\:')}:${desc
	`270`	`+ .replace('__yargsString__:', '')`
	`271`	+ .replace(/(\r\n\|\n\|\r)/gm, ' ')}`
`270`	`272`	`);`
`271`	`273`	`}`
`272`	`274`	`}`