fix(builder): nested builder is now awaited (#1925)

Benjamin E. Coe · web-flow · commit b5accd64ccbd · 2021-04-25T19:26:26.000-07:00
diff --git a/lib/command.ts b/lib/command.ts
@@ -307,7 +307,9 @@ export class CommandInstance {
     parentCommands: string[],
     commandIndex: number,
     helpOnly: boolean
-  ): {aliases: Dictionary<string[]>; innerArgv: Arguments} {
+  ):
+    | {aliases: Dictionary<string[]>; innerArgv: Arguments}
+    | Promise<{aliases: Dictionary<string[]>; innerArgv: Arguments}> {
     // A null command indicates we are running the default command,
     // if this is the case, we should show the root usage instructions
     // rather than the usage instructions for the nested default command:
@@ -334,10 +336,19 @@ export class CommandInstance {
         commandIndex,
         helpOnly
       );
-    return {
-      aliases: (innerYargs.parsed as DetailedArguments).aliases,
-      innerArgv: innerArgv as Arguments,
-    };
+    if (isPromise(innerArgv)) {
+      return innerArgv.then(argv => {
+        return {
+          aliases: (innerYargs.parsed as DetailedArguments).aliases,
+          innerArgv: argv,
+        };
+      });
+    } else {
+      return {
+        aliases: (innerYargs.parsed as DetailedArguments).aliases,
+        innerArgv: innerArgv,
+      };
+    }
   }
   private shouldUpdateUsage(yargs: YargsInstance) {
     return (
diff --git a/lib/yargs-factory.ts b/lib/yargs-factory.ts
@@ -1032,11 +1032,7 @@ export class YargsInstance {
     );
     this[kFreeze](); // Push current state of parser onto stack.
     if (typeof args === 'undefined') {
-      const argv = this[kRunYargsParserAndExecuteCommands](this.#processArgs);
-      const tmpParsed = this.parsed;
-      this[kUnfreeze](); // Pop the stack.
-      this.parsed = tmpParsed;
-      return argv;
+      args = this.#processArgs;
     }
 
     // a context object can optionally be provided, this allows
@@ -1063,6 +1059,7 @@ export class YargsInstance {
       args,
       !!shortCircuit
     );
+    const tmpParsed = this.parsed;
     this.#completion!.setParsed(this.parsed as DetailedArguments);
     if (isPromise(parsed)) {
       return parsed
@@ -1082,10 +1079,12 @@ export class YargsInstance {
         })
         .finally(() => {
           this[kUnfreeze](); // Pop the stack.
+          this.parsed = tmpParsed;
         });
     } else {
       if (this.#parseFn) this.#parseFn(this.#exitError, parsed, this.#output);
       this[kUnfreeze](); // Pop the stack.
+      this.parsed = tmpParsed;
     }
     return parsed;
   }
@@ -1983,7 +1982,6 @@ export class YargsInstance {
       const handlerKeys = this.#command.getCommands();
       const requestCompletions = this.#completion!.completionKey in argv;
       const skipRecommendation = helpOptSet || requestCompletions || helpOnly;
-
       if (argv._.length) {
         if (handlerKeys.length) {
           let firstUnknownCommand;
diff --git a/test/command.cjs b/test/command.cjs
@@ -2065,6 +2065,62 @@ describe('Command', () => {
           argv.help.should.equal(true);
         });
     });
+    // Refs: https://github.com/yargs/yargs/issues/1917
+    it('allows command to be defined in async builder', async () => {
+      let invoked = false;
+      await yargs('alpha beta')
+        .strict()
+        .command({
+          command: 'alpha',
+          describe: 'A',
+          builder: async yargs => {
+            await wait();
+            yargs
+              .command({
+                command: 'beta',
+                describe: 'B',
+                handler: () => {
+                  invoked = true;
+                },
+              })
+              .demandCommand(1);
+          },
+        })
+        .demandCommand(1)
+        .parse();
+      assert.strictEqual(invoked, true);
+    });
+    it('allows deeply nested command to be defined in async builder', async () => {
+      let invoked = false;
+      await yargs('alpha beta gamma')
+        .strict()
+        .command('alpha', 'A', async yargs => {
+          await wait();
+          yargs
+            .command({
+              command: 'beta',
+              describe: 'B',
+              builder: async yargs => {
+                await wait();
+                return yargs.command(
+                  'gamma',
+                  'C',
+                  async () => {
+                    await wait();
+                  },
+                  async () => {
+                    await wait();
+                    invoked = true;
+                  }
+                );
+              },
+            })
+            .demandCommand(1);
+        })
+        .demandCommand(1)
+        .parse();
+      assert.strictEqual(invoked, true);
+    });
   });
 
   describe('builder', () => {
diff --git a/test/usage.cjs b/test/usage.cjs
@@ -596,7 +596,6 @@ describe('usage tests', () => {
             // ignore the error, we only test the output here
           }
         });
-        console.info(r);
         r.errors
           .join('\n')
           .split(/\n+/)

Original file line number	Diff line number	Diff line change
`@@ -596,7 +596,6 @@ describe('usage tests', () => {`
`596`	`596`	`// ignore the error, we only test the output here`
`597`	`597`	`}`
`598`	`598`	`});`
`599`		`- console.info(r);`
`600`	`599`	`r.errors`
`601`	`600`	`.join('\n')`
`602`	`601`	`.split(/\n+/)`