fix: help strings for nested commands were missing parent commands (#990

)
yargs · Oct 19, 2017 · cd1ca15 · cd1ca15
1 parent 3c8ac1d
commit cd1ca15
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/lib/usage.js b/lib/usage.js
@@ -197,13 +197,16 @@ module.exports = function usage (yargs, y18n) {
     if (commands.length) {
       ui.div(__('Commands:'))
 
+      const context = yargs.getContext()
+      const parentCommands = context.commands.length ? `${context.commands.join(' ')} ` : ''
+
       commands.forEach((command) => {
-        const commandString = `${base$0} ${command[0].replace(/^\$0 ?/, '')}` // drop $0 from default commands.
+        const commandString = `${base$0} ${parentCommands}${command[0].replace(/^\$0 ?/, '')}` // drop $0 from default commands.
         ui.span(
           {
             text: commandString,
             padding: [0, 2, 0, 2],
-            width: maxWidth(commands, theWrap, base$0) + 4
+            width: maxWidth(commands, theWrap, `${base$0}${parentCommands}`) + 4
           },
           {text: command[1]}
         )

diff --git a/test/command.js b/test/command.js
@@ -536,8 +536,8 @@ describe('Command', () => {
         'command dream [command] [opts]',
         'Go to sleep and dream',
         'Commands:',
-        '  command of-memory <memory>               Dream about a specific memory',
-        '  command within-a-dream [command] [opts]  Dream within a dream',
+        '  command dream of-memory <memory>               Dream about a specific memory',
+        '  command dream within-a-dream [command] [opts]  Dream within a dream',
         'Options:',
         '  --help     Show help  [boolean]',
         '  --version  Show version number  [boolean]',
@@ -682,7 +682,7 @@ describe('Command', () => {
         'command cmd <sub>',
         'Try a command',
         'Commands:',
-        '  command sub  Run the subcommand',
+        '  command cmd sub  Run the subcommand',
         'Options:',
         '  --help     Show help  [boolean]',
         '  --version  Show version number  [boolean]',

diff --git a/test/yargs.js b/test/yargs.js
@@ -338,7 +338,7 @@ describe('yargs dsl tests', () => {
       })
     })
 
-    it("skips executing top-level command if builder's help is executed", () => {
+    it("skips executing root-level command if builder's help is executed", () => {
       const r = checkOutput(() => {
         yargs(['blerg', '-h'])
           .command(
@@ -362,7 +362,7 @@ describe('yargs dsl tests', () => {
         'handle blerg things',
         '',
         'Commands:',
-        '  usage snuh  snuh command',
+        '  usage blerg snuh  snuh command',
         '',
         'Options:',
         '  --version  Show version number  [boolean]',