feat(cli): --project-name init option

[nmussy]

Issue # (if applicable)

Closes #4865.

Reopened from #28979, which was automatically despite an exemption request being submitted

Reason for this change

Multiple requests have been made to allow the user to change the project name on cdk init, currently set to the working directory name, to a custom value.

Description of changes

This PR documents, implements and tests a new --project-name for the cdk init CLI. Its default value is the current behavior, i.e. the working directory name.

This PR follows up my previous attempt, now stale (#4884)

Description of how you validated changes

The new CLI option is being validated by a test added in init.test.ts

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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

[msambol]

is there any validation we need to do here? for example, are spaces allowed?

[nmussy]

Nothing is currently stopping a user from doing this:

mkdir "test folder with spaces"
cd "test folder with spaces"
npx cdk init --language=typescript

Which the CDK doesn't handle particularly well out of the box:
cdk.json

  "app": "npx ts-node --prefer-ts-exts bin/test folder with spaces.ts",

npm run cdk deploy

> test folder with spaces@0.1.0 cdk
> cdk deploy

node:internal/modules/cjs/loader:1147
  throw err;
  ^

Error: Cannot find module './test'

Manually quoting the path in "app" does seem to result in the deploy and destroy working

[msambol]

@nmussy Can you include a README update with this as well please?

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: ecbb87b
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[nmussy]

Can you include a README update with this as well please?

The documentation of the init command is currently pretty bare bones:

aws-cdk/packages/aws-cdk/README.md

Lines 56 to 73 in b148e58

	### `cdk init`
	Creates a new CDK project.
	```console
	$ # List the available template types & languages
	$ cdk init --list
	Available templates:
	* app: Template for a CDK Application
	└─ cdk init app --language=[csharp|fsharp|java|javascript|python|typescript]
	* lib: Template for a CDK Construct Library
	└─ cdk init lib --language=typescript
	* sample-app: Example CDK Application with some constructs
	└─ cdk init sample-app --language=[csharp|fsharp|java|javascript|python|typescript]
	$ # Create a new library application in typescript
	$ cdk init lib --language=typescript
	```

All of the options are listed in init --help, I don't think this one is more deserving of a README inclusion than say --role-arn or --generate-only

[msambol]

LGTM 👍🏼

[TheRealAmazonKendra]

Definitely closed due to our fault, not yours. We need to update our bot to not close PRs when the changes requested are because you're waiting on us. But also, we might have a bug because I thought I implemented that thing to not close when we have an exemption request or a clarification request. I could be misremembering, though. That was a hot minute ago.

[TheRealAmazonKendra]

Oops. I used all the keywords the bot responds to. I only meant to add the do-not-close label.

[TheRealAmazonKendra]

Anyway, I think I don't want to take this change as-is, not because your change isn't good but because of a previous one I (and others) made when making cdk migrate. We're verging a little on the side of spaghetti code here. Mistakes were made.

I'm doing some investigations that are tangentially related to this change to gimme a few days or so and I'll provide a meaningful response here with a solid path forward. But also, thanks for giving our init templates some attention. They need it.