test: add test demonstrating how to set custom description and aliases for help/version

OsmanAltun · web-flow · commit ecbc0377d8ac · 2021-04-10T20:03:56.000-07:00
diff --git a/test/usage.cjs b/test/usage.cjs
@@ -4503,4 +4503,23 @@ describe('usage tests', () => {
       }
     });
   });
+
+  // Refs: https://github.com/yargs/yargs/issues/1820
+  it('allows setting help and version with aliases and custom description', () => {
+    const r = checkUsage(() =>
+      yargs('--help')
+        .describe('help', 'Custom help description')
+        .describe('version', 'Custom version description')
+        .alias('help', 'h')
+        .alias('v', 'version')
+        .parse()
+    );
+    r.logs[0]
+      .split('\n')
+      .should.deep.equal([
+        'Options:',
+        '  -h, --help     Custom help description                               [boolean]',
+        '  -v, --version  Custom version description                            [boolean]',
+      ]);
+  });
 });
