chore(cli): convert dynamic commands to static (#18913)

We had a few commands defined dynamically through `yargs` [commandsDir](https://www.tabnine.com/code/javascript/functions/yargs/Argv/commandDir) option. This dynamic loading prevents bundling tools from detecting these imports and thus fails to run on a bundled package.

Explicitly define those commands just like all our other commands.

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*

Author: iliapolo

packages/aws-cdk/bin/cdk.ts

@@ -14,6 +14,9 @@ import { execProgram } from '../lib/api/cxapp/exec';
 import { ToolkitInfo } from '../lib/api/toolkit-info';
 import { StackActivityProgress } from '../lib/api/util/cloudformation/stack-activity-monitor';
 import { CdkToolkit } from '../lib/cdk-toolkit';
+import { realHandler as context } from '../lib/commands/context';
+import { realHandler as docs } from '../lib/commands/docs';
+import { realHandler as doctor } from '../lib/commands/doctor';
 import { RequireApproval } from '../lib/diff';
 import { availableInitLanguages, cliInit, printAvailableTemplates } from '../lib/init';
 import { data, debug, error, print, setLogLevel } from '../lib/logging';
@@ -39,6 +42,11 @@ async function parseCommandLineArguments() {
   //
   //   ./prog --arg one --arg two position  =>  will parse to  { arg: ['one', 'two'], _: ['positional'] }.
 
+  const defaultBrowserCommand: { [key in NodeJS.Platform]?: string } = {
+    darwin: 'open %u',
+    win32: 'start %u',
+  };
+
   const initTemplateLanguages = await availableInitLanguages();
   return yargs
     .env('CDK')
@@ -189,7 +197,17 @@ async function parseCommandLineArguments() {
       .option('list', { type: 'boolean', desc: 'List the available templates' })
       .option('generate-only', { type: 'boolean', default: false, desc: 'If true, only generates project files, without executing additional operations such as setting up a git repo, installing dependencies or compiling the project' }),
     )
-    .commandDir('../lib/commands', { exclude: /^_.*/ })
+    .command('context', 'Manage cached context values', yargs => yargs
+      .option('reset', { alias: 'e', desc: 'The context key (or its index) to reset', type: 'string', requiresArg: true })
+      .option('clear', { desc: 'Clear all context', type: 'boolean' }))
+    .command(['docs', 'doc'], 'Opens the reference documentation in a browser', yargs => yargs
+      .option('browser', {
+        alias: 'b',
+        desc: 'the command to use to open the browser, using %u as a placeholder for the path of the file to open',
+        type: 'string',
+        default: process.platform in defaultBrowserCommand ? defaultBrowserCommand[process.platform] : 'xdg-open %u',
+      }))
+    .command('doctor', 'Check your set-up for potential problems')
     .version(version.DISPLAY_VERSION)
     .demandCommand(1, '') // just print help
     .recommendCommands()
@@ -276,9 +294,25 @@ async function initCommandLine() {
   const commandOptions = { args: argv, configuration, aws: sdkProvider };
 
   try {
-    const returnValue = argv.commandHandler
-      ? await (argv.commandHandler as (opts: typeof commandOptions) => any)(commandOptions)
-      : await main(cmd, argv);
+
+    let returnValue = undefined;
+
+    switch (cmd) {
+      case 'context':
+        returnValue = await context(commandOptions);
+        break;
+      case 'docs':
+        returnValue = await docs(commandOptions);
+        break;
+      case 'doctor':
+        returnValue = await doctor(commandOptions);
+        break;
+    }
+
+    if (!returnValue) {
+      returnValue = await main(cmd, argv);
+    }
+
     if (typeof returnValue === 'object') {
       return toJsonOrYaml(returnValue);
     } else if (typeof returnValue === 'string') {

packages/aws-cdk/lib/commands/context.ts

@@ -1,30 +1,10 @@
 import * as chalk from 'chalk';
-import * as yargs from 'yargs';
 import * as version from '../../lib/version';
 import { CommandOptions } from '../command-api';
 import { print } from '../logging';
 import { Context, PROJECT_CONFIG } from '../settings';
 import { renderTable } from '../util';
 
-export const command = 'context';
-export const describe = 'Manage cached context values';
-export const builder = {
-  reset: {
-    alias: 'e',
-    desc: 'The context key (or its index) to reset',
-    type: 'string',
-    requiresArg: true,
-  },
-  clear: {
-    desc: 'Clear all context',
-    type: 'boolean',
-  },
-};
-
-export function handler(args: yargs.Arguments) {
-  args.commandHandler = realHandler;
-}
-
 export async function realHandler(options: CommandOptions): Promise<number> {
   const { configuration, args } = options;
 

packages/aws-cdk/lib/commands/docs.ts

@@ -1,36 +1,12 @@
 import * as childProcess from 'child_process';
-import * as process from 'process';
 import * as chalk from 'chalk';
-import * as yargs from 'yargs';
 import { debug, print, warning } from '../../lib/logging';
 import { CommandOptions } from '../command-api';
 
 export const command = 'docs';
 export const describe = 'Opens the reference documentation in a browser';
 export const aliases = ['doc'];
 
-const defaultBrowserCommand: { [key in NodeJS.Platform]?: string } = {
-  darwin: 'open %u',
-  win32: 'start %u',
-};
-
-export const builder = {
-  browser: {
-    alias: 'b',
-    desc: 'the command to use to open the browser, using %u as a placeholder for the path of the file to open',
-    type: 'string',
-    default: process.platform in defaultBrowserCommand ? defaultBrowserCommand[process.platform] : 'xdg-open %u',
-  },
-};
-
-export interface Arguments extends yargs.Arguments {
-  browser: string
-}
-
-export function handler(args: yargs.Arguments) {
-  args.commandHandler = realHandler;
-}
-
 export async function realHandler(options: CommandOptions): Promise<number> {
   const url = 'https://docs.aws.amazon.com/cdk/api/v2/';
   print(chalk.green(url));

packages/aws-cdk/lib/commands/doctor.ts

@@ -1,19 +1,10 @@
 import * as process from 'process';
 import * as cxapi from '@aws-cdk/cx-api';
 import * as chalk from 'chalk';
-import * as yargs from 'yargs';
 import { print } from '../../lib/logging';
 import * as version from '../../lib/version';
 import { CommandOptions } from '../command-api';
 
-export const command = 'doctor';
-export const describe = 'Check your set-up for potential problems';
-export const builder = {};
-
-export function handler(args: yargs.Arguments) {
-  args.commandHandler = realHandler;
-}
-
 export async function realHandler(_options: CommandOptions): Promise<number> {
   let exitStatus: number = 0;
   for (const verification of verifications) {

packages/aws-cdk/test/cdk-docs.test.ts

@@ -1,5 +1,6 @@
 import * as mockery from 'mockery';
 import { CommandHandler } from '../lib/command-api';
+import { realHandler } from '../lib/commands/docs';
 
 const argv = {
   browser: 'echo %u',
@@ -25,9 +26,7 @@ describe('`cdk docs`', () => {
   });
 
   test('exits with 0 when everything is OK', async () => {
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    require('../lib/commands/docs').handler(argv);
-    const result = await argv.commandHandler!({ args: argv } as any);
+    const result = await realHandler({ args: argv } as any);
     expect(result).toBe(0);
   });
 
@@ -37,9 +36,7 @@ describe('`cdk docs`', () => {
         cb(new Error('TEST'));
       },
     });
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    require('../lib/commands/docs').handler(argv);
-    const result = await argv.commandHandler!({ args: argv } as any);
+    const result = await realHandler({ args: argv } as any);
     expect(result).toBe(0);
   });
 });

packages/aws-cdk/test/cdk-doctor.test.ts

@@ -1,5 +1,5 @@
 import * as mockery from 'mockery';
-import { CommandHandler } from '../lib/command-api';
+import { realHandler } from '../lib/commands/doctor';
 
 describe('`cdk doctor`', () => {
   beforeEach(done => {
@@ -18,9 +18,7 @@ describe('`cdk doctor`', () => {
 
   test('exits with 0 when everything is OK', async () => {
     const argv: any = {};
-    // eslint-disable-next-line @typescript-eslint/no-require-imports
-    require('../lib/commands/doctor').handler(argv);
-    const result = await (argv.commandHandler as CommandHandler)({ args: argv } as any);
+    const result = await realHandler({ args: argv } as any);
     expect(result).toBe(0);
   });
 });