-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(cdk): add --project-name init option #28979
Conversation
@@ -271,7 +271,8 @@ async function parseCommandLineArguments(args: string[]) { | |||
.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('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' }), | |||
.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' }) | |||
.option('project-name', { type: 'string', desc: 'Name of the generated project (defaults to current directory name)', requiresArg: true }), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me know if you would also like me to describe the new option in aws-cdk/README.md
, or if this --help
output is sufficient
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.
A comment requesting an exemption should contain the text Exemption Request
. Additionally, if clarification is needed add Clarification Request
to a comment.
Exemption Request:
|
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
This PR has been in the CHANGES REQUESTED state for 3 weeks, and looks abandoned. To keep this PR from being closed, please continue work on it. If not, it will automatically be closed in a week. |
I have not abandoned this PR, and am still awaiting a review |
This PR has been deemed to be abandoned, and will be automatically closed. Please create a new PR for these changes if you think this decision has been made in error. |
The pull request linter fails with the following errors:
PRs must pass status checks before we can provide a meaningful review. If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing ✅ A exemption request has been requested. Please wait for a maintainer's review. |
Sorry, I should have indicated that I reopened the same PR in #29695, given I couldn't reopen this one 👍 |
Issue # (if applicable)
Closes #4865.
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 thecdk 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
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license