chore(cli): rename _ to command in UserInput (#32822)

This does not change CLI functionality because `UserInput` is not in use yet. Since we have full control over `UserInput`, i.e. we control the input functions from the CLI or `cdk.json`, we can rename properties however we like. `_` is a relic of `yargs`, we do not need to maintain that convention.


----

*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-user-input.ts

@@ -251,7 +251,7 @@ export function convertYargsToUserInput(args: any): UserInput {
       break;
   }
   const userInput: UserInput = {
-    _: args._[0],
+    command: args._[0],
     globalOptions,
     [args._[0]]: commandOptions,
   };

packages/aws-cdk/lib/user-input.ts

@@ -14,7 +14,7 @@ export interface UserInput {
   /**
    * The CLI command name
    */
-  readonly _?: Command;
+  readonly command?: Command;
 
   /**
    * Global options available to all CLI commands

packages/aws-cdk/test/cli-arguments.test.ts

@@ -8,7 +8,7 @@ describe('yargs', () => {
     const result = convertYargsToUserInput(input);
 
     expect(result).toEqual({
-      _: 'deploy',
+      command: 'deploy',
       globalOptions: {
         app: undefined,
         assetMetadata: undefined,
@@ -73,7 +73,7 @@ describe('yargs', () => {
     const result = convertYargsToUserInput(input);
 
     expect(result).toEqual({
-      _: 'deploy',
+      command: 'deploy',
       deploy: expect.objectContaining({
         STACKS: ['stack1', 'stack2'],
       }),
@@ -87,7 +87,7 @@ describe('yargs', () => {
     const result = convertYargsToUserInput(input);
 
     expect(result).toEqual({
-      _: 'acknowledge',
+      command: 'acknowledge',
       acknowledge: expect.objectContaining({
         ID: 'id1',
       }),

tools/@aws-cdk/user-input-gen/lib/convert-to-user-input-gen.ts

@@ -142,7 +142,7 @@ function buildPositionalArguments(arg: { name: string; variadic: boolean }, argN
 function buildUserInput(argName: string): string {
   return [
     'const userInput: UserInput = {',
-    `_: ${argName}._[0],`,
+    `command: ${argName}._[0],`,
     'globalOptions,',
     `[${argName}._[0]]: commandOptions`,
     '}',

tools/@aws-cdk/user-input-gen/lib/user-input-gen.ts

@@ -25,7 +25,7 @@ export async function renderUserInputType(config: CliConfig): Promise<string> {
   const commandEnum = Type.fromName(scope, 'Command');
 
   userInputType.addProperty({
-    name: '_',
+    name: 'command',
     type: commandEnum,
     docs: {
       summary: 'The CLI command name',

tools/@aws-cdk/user-input-gen/test/convert-to-user-input-gen.test.ts

@@ -71,7 +71,7 @@ describe('render', () => {
             break;
         }
         const userInput: UserInput = {
-          _: args._[0],
+          command: args._[0],
           globalOptions,
           [args._[0]]: commandOptions,
         };

tools/@aws-cdk/user-input-gen/test/user-input-gen.test.ts

@@ -60,7 +60,7 @@ describe('render', () => {
         /**
          * The CLI command name
          */
-        readonly _?: Command;
+        readonly command?: Command;
 
         /**
          * Global options available to all CLI commands
@@ -169,7 +169,7 @@ describe('render', () => {
         /**
          * The CLI command name
          */
-        readonly _?: Command;
+        readonly command?: Command;
 
         /**
          * Global options available to all CLI commands
@@ -251,7 +251,7 @@ describe('render', () => {
         /**
          * The CLI command name
          */
-        readonly _?: Command;
+        readonly command?: Command;
 
         /**
          * Global options available to all CLI commands