Feat/init overwrite #1477
Merged
Feat/init overwrite #1477
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
willemneal
reviewed
Jul 23, 2024
willemneal
reviewed
Jul 23, 2024
willemneal
reviewed
Jul 23, 2024
willemneal
reviewed
Jul 23, 2024
|
logic cleaned up |
willemneal
reviewed
Jul 23, 2024
willemneal
reviewed
Jul 23, 2024
simplify appended check Co-authored-by: Willem Wyndham <[email protected]>
simplified appended check Co-authored-by: Willem Wyndham <[email protected]>
| @@ -424,6 +424,7 @@ Initialize a Soroban project with an example contract | |||
| * `-f`, `--frontend-template <FRONTEND_TEMPLATE>` — An optional flag to pass in a url for a frontend template repository. | |||
|
|
|||
| Default value: `` | |||
| * `-o`, `--overwrite` — Overwrite all existing files. | |||
There was a problem hiding this comment.
I don't think we should add the short option -o, opened a PR removing it and why is mentioned there:
| @@ -47,6 +47,9 @@ pub struct Cmd { | |||
| long_help = "An optional flag to pass in a url for a frontend template repository." | |||
| )] | |||
| pub frontend_template: String, | |||
|
|
|||
| #[arg(short, long, long_help = "Overwrite all existing files.")] | |||
There was a problem hiding this comment.
Is the intent that the command will overwrite the entire directory such as remove the directory contents first, then start writing? Or is the intent that the command will overwrite individual files also included in the template and leave any additional files as they are?
The term 'all' may introduce some ambiguity to the scope of what is removed, and given the destructive nature of this command we should try and limit the ambiguity.
The term 'any' may limit the ambiguity, although not perfectly.
Suggested change
| #[arg(short, long, long_help = "Overwrite all existing files.")] | |
| #[arg(short, long, long_help = "Overwrite any existing files.")] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Adds an --overwrite option to
contract initWhy
Useful if you don't want to delete the files yourself - requested here #1425
Close #1425
Known limitations
N/A