cdk: add option to specify projectName to `cdk init`

[ren-yamanashi]

Describe the feature

When running cdk init, I want to pass projectName as a command option.

Use Case

I'm always frustrated when I have to manually change the stack name and file names generated by cdk init.
This could be resolved by making a projectName option available.

Proposed Solution

I think the steps for possible implementation are as follows

1. Add name option

For example, add name to the command options.
(see: https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/lib/cli.ts#L304-L308)

    .command('init [TEMPLATE]', 'Create a new, empty CDK project from a template.', (yargs: Argv) => yargs
      .option('language', { type: 'string', alias: 'l', desc: 'The language to be used for the new project (default can be configured in ~/.cdk.json)', choices: initTemplateLanguages })
+    .option('name', { type: 'string', alias: 'n', desc: 'The name of new project' })
      .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' }),
    )

2. Modify the implementation of packages/aws-cdk/lib/init.ts

Add the name property to CliInitOptions and modify the install method as follows (see: https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk/lib/init.ts)

-  public async install(language: string, targetDirectory: string, stackName?: string) {
+  public async install(language: string, targetDirectory: string, name?:string, stackName?: string) {
  // ... some implementations
    const projectInfo: ProjectInfo = {
-     name: decamelize(path.basename(path.resolve(targetDirectory))),
+     name: decamelize(name ?? path.basename(path.resolve(targetDirectory))),
      stackName,
    };
  // ... some implementations
  }

Other Information

No response

Acknowledgements

• [X] I may be able to implement this feature request
• [ ] This feature might incur a breaking change

CDK version used

2.146.0

Environment details (OS name and version, etc.)

macOS Sonoma v14.0

[tmokmss]

related: #29695

[ashishdhingra]

Findings:

• cdk init uses the execution flow: cliInit() > initializeProject() > InitTemplate.install().
• InitTemplate.install() reads template based on specified language from lib/init-templates directory (list of available templates are read via availableInitTemplates() which is invoked here).
• CliInitOptions supports stackName, but this option is not set while invoking cdk init here.
• When InitTemplate.install() is executes, it initializes ProjectInfo which supports name and stackName properties, here.

• ProjectInfo is used when executing installFiles(). At this code,

  • name is used for replacing %name% placeholder.
  • stackName is used to replace %stackName% placeholder.

  If we look at one of the template files for typescript, it uses %name% placeholder, so related PR https://github.com/aws/aws-cdk/pull/29695 should address this issue (however, also refer https://github.com/aws/aws-cdk/pull/29695#issuecomment-2036299912). So this issue appears to be duplicate of https://github.com/aws/aws-cdk/issues/4865 if PR still holds good.

[megarach0]

Findings:

• cdk init uses the execution flow: cliInit() > initializeProject() > InitTemplate.install().
• InitTemplate.install() reads template based on specified language from lib/init-templates directory (list of available templates are read via availableInitTemplates() which is invoked here).
• CliInitOptions supports stackName, but this option is not set while invoking cdk init here.
• When InitTemplate.install() is executes, it initializes ProjectInfo which supports name and stackName properties, here.

• ProjectInfo is used when executing installFiles(). At this code,

  • name is used for replacing %name% placeholder.
  • stackName is used to replace %stackName% placeholder.

  If we look at one of the template files for typescript, it uses %name% placeholder, so related PR feat(cli): --project-name init option #29695 should address this issue (however, also refer feat(cli): --project-name init option #29695 (comment)). So this issue appears to be duplicate of cdk init should have option to produce new project with fixed file and class names #4865 if PR still holds good.

The comment for #29695 mentioned above was made in April. Any update on how we should deal with this issue going forward?