This repository has been archived by the owner on Jan 5, 2022. It is now read-only.
feat: Link new and migrate command with the init functionality #66
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamie-lynch
force-pushed
the
jl/link-commands
branch
4 times, most recently
from
0349613
to
08a467b
Compare
jamie-lynch
changed the title
jamie-lynch
force-pushed
the
jl/link-commands
branch
from
08a467b
to
780501f
Compare
jacobwinch
approved these changes
Feb 17, 2021
jacobwinch
reviewed
Feb 17, 2021
| @@ -112,7 +113,8 @@ ARGUMENTS | |||
| OPTIONS | |||
| -h, --help show CLI help | |||
| -v, --version show CLI version | |||
| --multi-app | |||
| --init create the cdk directory before building the app and stack files | |||
There was a problem hiding this comment.
I wonder if this should be the default behaviour for the new command? Perhaps we could consider that in a future PR though.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this change?
This PR links the functionality of the new and migrate commands with the init command to allow both steps to be done in one command. The first step of this work was refactoring the bulk of the initialisation logic into a new class in the
utils/init.tsfile. An--initflag was then added to both thenewandmigratecommand. If this flag is passed in then thecdkproject directory is created before the rest of the command is executed.How to test
Try running the
newandmigratecommands both with and without the--initflag appended to see the project directory being created.How can we measure success?
Users don't have to run the
initcommand followed by either thenewormigratecommands when starting a new cdk project.Have we considered potential risks?
There is some risk when running commands that interact with the filesystem but validation has been added to check if files and directories already exist before taking any action.