Skip to content

Warn when alias shadows external subcommand #10082

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.

Sign up for GitHub

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

Merged
bors merged 6 commits into from
Nov 17, 2021
Merged

Warn when alias shadows external subcommand #10082

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5bfd345
Warn when alias shadows external subcommand
basile-henry Nov 14, 2021
9f768bb
Update test for warning for alias shadowing an external subcommand
basile-henry Nov 14, 2021
2ead2d9
Update tests/testsuite/cargo_alias_config.rs
basile-henry Nov 14, 2021
3a5bb75
Update tests/testsuite/cargo_alias_config.rs
basile-henry Nov 14, 2021
cba8503
Add details in warning for alias shadowing external subcommands
basile-henry Nov 17, 2021
0b4e2ca
Add test for alias shadowing external subcommand
basile-henry Nov 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/bin/cargo/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,18 @@ fn expand_aliases(
}
(None, None) => {}
(_, Some(mut alias)) => {
// Check if this alias is shadowing an external subcommand
// (binary of the form `cargo-<subcommand>`)
// Currently this is only a warning, but after a transition period this will become
// a hard error.
if let Some(path) = super::find_external_subcommand(config, cmd) {
config.shell().warn(format!(
"user-defined alias `{}` is shadowing an external subcommand found at: `{}`",
Copy link
Contributor

@ehuss ehuss Nov 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this include additional text explaining that this will become an error in the future? And some detail explaining why it is being changed (perhaps just a link to #10049 will be sufficient). Maybe something like this?

This was previously accepted but is being phased out; it will become a hard error in a future release.
For more information, see issue #10049 <https://github.com/rust-lang/cargo/issues/10049>.

cmd,
path.display(),
))?;
}

alias.extend(
args.values_of("")
.unwrap_or_default()
Expand Down
10 changes: 7 additions & 3 deletions src/bin/cargo/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,16 @@ fn list_commands(config: &Config) -> BTreeMap<String, CommandInfo> {
commands
}

fn execute_external_subcommand(config: &Config, cmd: &str, args: &[&str]) -> CliResult {
fn find_external_subcommand(config: &Config, cmd: &str) -> Option<PathBuf> {
let command_exe = format!("cargo-{}{}", cmd, env::consts::EXE_SUFFIX);
let path = search_directories(config)
search_directories(config)
.iter()
.map(|dir| dir.join(&command_exe))
.find(|file| is_executable(file));
.find(|file| is_executable(file))
}

fn execute_external_subcommand(config: &Config, cmd: &str, args: &[&str]) -> CliResult {
let path = find_external_subcommand(config, cmd);
let command = match path {
Some(command) => command,
None => {
Expand Down
12 changes: 9 additions & 3 deletions tests/testsuite/cargo_alias_config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,20 @@ fn default_args_alias() {
p.cargo("echo")
.env("PATH", &path)
.with_status(101)
.with_stderr("error: alias echo has unresolvable recursive definition: echo -> echo")
.with_stderr("\
warning: user-defined alias `echo` is shadowing an external subcommand found at: `[ROOT]/cargo-echo/target/debug/cargo-echo`
error: alias echo has unresolvable recursive definition: echo -> echo
",
)
.run();

p.cargo("test-1")
.env("PATH", &path)
.with_status(101)
.with_stderr(
"error: alias test-1 has unresolvable recursive definition: test-1 -> echo -> echo",
.with_stderr("\
warning: user-defined alias `echo` is shadowing an external subcommand found at: `[ROOT]/cargo-echo/target/debug/cargo-echo`
error: alias test-1 has unresolvable recursive definition: test-1 -> echo -> echo
",
)
.run();

Expand Down