chore(cli): aliased commands can be converted to cli args (#32806)

This PR does not currently change CLI functionality. The function
`convertToCliArgs` is not used in the CLI yet which is why this PR is
not fixing a regression. It will eventually be used to strongly-type cli
arguments.

Previously, aliased commands, like `cdk ack` instead of `cdk
acknowledge` would fall through the cracks of the generated convert
function. The switch statement was only switching on command names so we
would not store any options associated with an aliased command.
Specifically, `cdk synth --exclusively` would _not_ store the
`exclusively` flag in the ensuing `CliArguments` object because `synth`
is an alias.

Now we do. This is an additional step forward to being able to use
`CliArguments` in `cli.ts`

----

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

Author: kaizencc

packages/aws-cdk/lib/convert-to-cli-args.ts

@@ -38,6 +38,7 @@ export function convertToCliArgs(args: any): CliArguments {
   let commandOptions;
   switch (args._[0] as Command) {
     case 'list':
+    case 'ls':
       commandOptions = {
         long: args.long,
         showDependencies: args.showDependencies,
@@ -46,6 +47,7 @@ export function convertToCliArgs(args: any): CliArguments {
       break;
 
     case 'synthesize':
+    case 'synth':
       commandOptions = {
         exclusively: args.exclusively,
         validation: args.validation,
@@ -193,6 +195,7 @@ export function convertToCliArgs(args: any): CliArguments {
       break;
 
     case 'acknowledge':
+    case 'ack':
       commandOptions = {
         ID: args.ID,
       };
@@ -237,6 +240,7 @@ export function convertToCliArgs(args: any): CliArguments {
       break;
 
     case 'docs':
+    case 'doc':
       commandOptions = {
         browser: args.browser,
       };

packages/aws-cdk/lib/settings.ts

@@ -36,10 +36,12 @@ export enum Command {
   ROLLBACK = 'rollback',
   IMPORT = 'import',
   ACKNOWLEDGE = 'acknowledge',
+  ACK = 'ack',
   NOTICES = 'notices',
   MIGRATE = 'migrate',
   CONTEXT = 'context',
   DOCS = 'docs',
+  DOC = 'doc',
   DOCTOR = 'doctor',
 }
 

tools/@aws-cdk/cli-args-gen/lib/cli-args-function-gen.ts

@@ -64,7 +64,9 @@ function buildCommandSwitch(config: CliConfig): string {
   const commandSwitchExprs = ['let commandOptions;', 'switch (args._[0] as Command) {'];
   for (const commandName of Object.keys(config.commands)) {
     commandSwitchExprs.push(
-      `case '${commandName}':`,
+      // All aliases of the command should map to the same switch branch
+      // This ensures that we store options of the command regardless of what alias is specified
+      ...buildAliases(commandName, config.commands[commandName].aliases),
       'commandOptions = {',
       ...buildCommandOptions(config.commands[commandName]),
       ...(config.commands[commandName].arg ? [buildPositionalArguments(config.commands[commandName].arg)] : []),
@@ -76,6 +78,11 @@ function buildCommandSwitch(config: CliConfig): string {
   return commandSwitchExprs.join('\n');
 }
 
+function buildAliases(commandName: string, aliases: string[] = []): string[] {
+  const cases = [commandName, ...aliases];
+  return cases.map((c) => `case '${c}':`);
+}
+
 function buildCommandOptions(options: CliAction): string[] {
   const commandOptions: string[] = [];
   for (const optionName of Object.keys(options.options ?? {})) {

tools/@aws-cdk/cli-args-gen/test/cli-args-function-gen.test.ts

@@ -31,6 +31,7 @@ describe('render', () => {
             variadic: true,
           },
           description: 'Deploy a stack',
+          aliases: ['d'],
           options: {
             all: {
               type: 'boolean',
@@ -62,6 +63,7 @@ describe('render', () => {
         let commandOptions;
         switch (args._[0] as Command) {
           case 'deploy':
+          case 'd':
             commandOptions = {
               all: args.all,
               STACKS: args.STACKS,