Prevent cargo init in home directory
#16566
Merged
+62
−6
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
rustbot
added
Command-new
S-waiting-on-review
Collaborator
Contributor
Author
|
r? @epage |
Contributor
|
Thanks for working on this! As a heads up, we''ve found it really helpful for contributors and reviewers to split the tests out into their own commit before the change with them passing, showing the existing behavior you wish to change. Then you fix commit will update the test to reflect the new behavior with the diff between them showing how your changes affected behavior. For more on this, including example PRs, see https://doc.crates.io/contrib/process/working-on-cargo.html#submitting-a-pull-request. |
epage
reviewed
Jan 28, 2026
terror
force-pushed
the
cargo-init-home-directory
branch
from
b17eb3d to
a3621f6
Compare
terror
force-pushed
the
cargo-init-home-directory
branch
from
a3621f6 to
fd59dc2
Compare
epage
approved these changes
Jan 28, 2026
ranger-ross
reviewed
Jan 28, 2026
Comment on lines
+500
to
+507
| if let Some(home) = home_dir() { | ||
| if path == &home { | ||
| anyhow::bail!( | ||
| "cannot create package in the home directory\n\n\ | ||
| help: use `cargo init <path>` to create a package in a different directory" | ||
| ) | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
nit: you can flatten these if statements
if let Some(home) = home_dir() && path == &home { ... }| #[cargo_test] | ||
| fn case() { | ||
| snapbox::cmd::Command::cargo_ui() | ||
| .arg_line("init --vcs none") |
Member
There was a problem hiding this comment.
why is --vcs none removed in the second commit?
(Or added in the first commit?)
rustbot
removed
the
S-waiting-on-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Resolves #16562
Running
cargo initin the home directory can lead to confusing states, particularly for new users experimenting with Cargo. ACargo.tomlin the home directory causes issues with file discovery, as Cargo will treat the entire home directory as a package root when running commands from any subdirectory.This diff adds a check to error out when
cargo initis run in the home directory, with a message suggesting to usecargo init <path>instead.