[init] init config should return error if already exists #2346
Conversation
This file contains hidden or 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
|
If we want to be really cautious/backwards compatible here, we could have it emit a warning for 1 release, and then make it a hard error in a subsequent release |
gcurtis
approved these changes
Oct 11, 2024
savil
reviewed
Oct 11, 2024
internal/boxcli/init.go
Outdated
| if path == "" || path == "." { | ||
| path, _ = os.Getwd() | ||
| } | ||
| return usererr.New("devbox.json already exists in %q.", path) |
There was a problem hiding this comment.
Could we make switch this to a warning emitted instead and make it a non-error?
I don't think its that bad to run devbox init if a devbox.json already exists. Its useful for scripts.
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
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.
Summary
This fixes a NPE in autodetect. Previously when initializing a config with a directory that already contained a config we would return
(nil, nil)but this is a mistake and a bit inconsistent with typical go. This changes it so that if config already exists we return an error instead.IMO this also provides better UX displaying a message indicating config already exists.
This does have a minor backward compatibility issue. If users where used to calling
devbox initand having it not fail they would now need to first test if devbox.json already exists.How was it tested?