feat(cli): add --name option to cdk init (#990)

Author: alias-rahil

packages/aws-cdk/lib/cli/cli-type-registry.json

@@ -913,6 +913,12 @@
             "pnpm",
             "bun"
           ]
+        },
+        "name": {
+          "type": "string",
+          "alias": "n",
+          "desc": "The name of the new project",
+          "requiresArg": true
         }
       },
       "implies": {

packages/aws-cdk/lib/cli/cli.ts

@@ -562,6 +562,7 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
             fromPath: args['from-path'],
             templatePath: args['template-path'],
             packageManager: args['package-manager'],
+            name: args.name,
           });
         }
       case 'migrate':

packages/aws-cdk/lib/cli/convert-to-user-input.ts

@@ -251,6 +251,7 @@ export function convertYargsToUserInput(args: any): UserInput {
         fromPath: args.fromPath,
         templatePath: args.templatePath,
         packageManager: args.packageManager,
+        name: args.name,
         TEMPLATE: args.TEMPLATE,
       };
       break;

packages/aws-cdk/lib/cli/parse-command-line-arguments.ts

@@ -900,6 +900,13 @@ export function parseCommandLineArguments(args: Array<string>): any {
           type: 'string',
           desc: 'The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects. Defaults to npm in TypeScript and JavaScript projects.',
           choices: ['npm', 'yarn', 'pnpm', 'bun'],
+        })
+        .option('name', {
+          default: undefined,
+          type: 'string',
+          alias: 'n',
+          desc: 'The name of the new project',
+          requiresArg: true,
         }),
     )
     .command('migrate', 'Migrate existing AWS resources into a CDK app', (yargs: Argv) =>

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

@@ -1415,6 +1415,15 @@ export interface InitOptions {
    */
   readonly packageManager?: string;
 
+  /**
+   * The name of the new project
+   *
+   * aliases: n
+   *
+   * @default - undefined
+   */
+  readonly name?: string;
+
   /**
    * Positional argument for init
    */

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

@@ -48,6 +48,11 @@ export interface CliInitOptions {
    */
   readonly workDir?: string;
 
+  /**
+   * @default undefined
+   */
+  readonly name?: string;
+
   /**
    * @default undefined
    */
@@ -122,6 +127,7 @@ export async function cliInit(options: CliInitOptions) {
     canUseNetwork,
     generateOnly,
     workDir,
+    options.name,
     options.stackName,
     options.migrate,
     options.libVersion,
@@ -427,6 +433,7 @@ export class InitTemplate {
     ioHelper: IoHelper,
     language: string,
     targetDirectory: string,
+    name?: string,
     stackName?: string,
     libVersion?: string,
     packageManager?: JsPackageManager,
@@ -440,7 +447,7 @@ export class InitTemplate {
     }
 
     const projectInfo: ProjectInfo = {
-      name: decamelize(path.basename(path.resolve(targetDirectory))),
+      name: name ? decamelize(name) : decamelize(path.basename(path.resolve(targetDirectory))),
       stackName,
       versions: await loadInitVersions(),
     };
@@ -695,6 +702,7 @@ async function initializeProject(
   canUseNetwork: boolean,
   generateOnly: boolean,
   workDir: string,
+  name?: string,
   stackName?: string,
   migrate?: boolean,
   cdkVersion?: string,
@@ -705,7 +713,7 @@ async function initializeProject(
 
   // Step 2: Copy template files
   await ioHelper.defaults.info(`Applying project template ${chalk.green(template.name)} for ${chalk.blue(language)}`);
-  await template.install(ioHelper, language, workDir, stackName, cdkVersion, packageManager);
+  await template.install(ioHelper, language, workDir, name, stackName, cdkVersion, packageManager);
 
   if (migrate) {
     await template.addMigrateContext(workDir);

packages/aws-cdk/test/commands/init.test.ts

@@ -65,6 +65,19 @@ describe('constructs version', () => {
     expect(Object.entries(pj.devDependencies)).toContainEqual(['aws-cdk-lib', '2.100']);
   });
 
+  cliTest('can specify project name with --name option', async (workDir) => {
+    await cliInit({
+      ioHelper,
+      type: 'app',
+      language: 'typescript',
+      workDir,
+      name: 'my-project',
+    });
+
+    const stackFile = await fs.readFile(path.join(workDir, 'lib', 'my-project-stack.ts'), 'utf-8');
+    expect(stackFile).toContain('export class MyProjectStack');
+  });
+
   cliTest('asking for a nonexistent template fails', async (workDir) => {
     await expect(cliInit({
       ioHelper,