-
Notifications
You must be signed in to change notification settings - Fork 4k
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
cdk init should have option to produce new project with fixed file and class names #4865
Comments
I think it makes sense to support something like |
Thanks for the ping Elad. I can definitely look into it, I should be available tonight. |
@eladb That's an even better solution than my idea. I like it. |
This is really needed feature. |
is this available? |
I agree this would be very helpful |
Hi, if the feature is still welcome I'd like to try working on a PR. |
I like the idea of being able to provide a custom package name, instead of "hello-cdk". |
There should be a
cdk init
template that doesn't use the name of the project folder to generate file and class names.Use Case
Every once in a while I get feedback on the Getting Started topic in the Developer Guide stating that a class name or filename is wrong. Inevitably this is caused by someone who has named their folder something other than "hello-cdk" as the instructions direct. Since
cdk init
uses the project folder name as part of the generated file and class names, this throws off all the rest of the instructions, and the customer has trouble getting the example to work.This is by far the single most common issue reported with the CDK Developer Guide. I added a note to Getting Started describing the issue and explaining the importance of naming their project folder "hello-cdk," but I just received another report of it.
It would improve the Getting Started experience if we could remove this stumbling block to customers being successful at trying out the CDK.
Proposed Solution
Let's provide a template (maybe named something like "hello") that we can use specifically in Getting Started and perhaps the CDK Workshop. This template should use static file and class names so the customer can name their project folder whatever they want without affecting the files inside it.
This is a 🚀 Feature Request
The text was updated successfully, but these errors were encountered: