Skip to content

feat(tree): Add more native completions #16296

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
merged 4 commits into from
Nov 25, 2025
+79 −71
Merged

feat(tree): Add more native completions #16296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ab6e94f
feat(tree): Complete --prune SPEC
epage Nov 24, 2025
ca352bc
refactor(tree): Leverage clap for value splitting
epage Nov 24, 2025
a4641ab
feat(tree): Start completing --edges
epage Nov 24, 2025
8a186b8
fix(tree): Order --edges according to 'cargo help tree'
epage Nov 24, 2025
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
53 changes: 28 additions & 25 deletions src/bin/cargo/commands/tree.rs
View file
Open in desktop
Copy link
Member

@weihanglo weihanglo Nov 24, 2025

Choose a reason for hiding this comment

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

Should we simplify this, as clap handles it already?

cargo/src/bin/cargo/commands/tree.rs

Lines 308 to 316 in f3b7ff7

let unknown = |k| {
bail!(
"unknown edge kind `{}`, valid values are \
\"normal\", \"build\", \"dev\", \
\"no-normal\", \"no-build\", \"no-dev\", \"no-proc-macro\", \
\"features\", or \"all\"",
k
)
};

Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,21 @@ pub fn cli() -> Command {
.arg_silent_suggestion()
.arg(flag("no-dev-dependencies", "Deprecated, use -e=no-dev instead").hide(true))
.arg(
multi_opt(
"edges",
"KINDS",
"The kinds of dependencies to display \
(features, normal, build, dev, all, \
no-normal, no-build, no-dev, no-proc-macro)",
)
.short('e'),
multi_opt("edges", "KINDS", "The kinds of dependencies to display")
.short('e')
.value_delimiter(',')
.value_parser([
"all",
"normal",
"build",
"dev",
"features",
"public",
"no-normal",
"no-build",
"no-dev",
"no-proc-macro",
]),
)
.arg(
optional_multi_opt(
Expand All @@ -42,11 +49,16 @@ pub fn cli() -> Command {
get_pkg_id_spec_candidates,
)),
)
.arg(multi_opt(
"prune",
"SPEC",
"Prune the given package from the display of the dependency tree",
))
.arg(
multi_opt(
"prune",
"SPEC",
"Prune the given package from the display of the dependency tree",
)
.add(clap_complete::ArgValueCandidates::new(
get_pkg_id_spec_candidates,
)),
)
.arg(opt("depth", "Maximum display depth of the dependency tree").value_name("DEPTH"))
.arg(flag("no-indent", "Deprecated, use --prefix=none instead").hide(true))
.arg(flag("prefix-depth", "Deprecated, use --prefix=depth instead").hide(true))
Expand Down Expand Up @@ -266,7 +278,7 @@ fn parse_edge_kinds(
let mut kinds = args.get_many::<String>("edges").map_or_else(
|| Vec::new(),
|es| {
es.flat_map(|e| e.split(','))
es.map(|e| e.as_str())
.filter(|e| {
if *e == "no-proc-macro" {
no_proc_macro = true;
Expand Down Expand Up @@ -305,15 +317,6 @@ fn parse_edge_kinds(
result.insert(EdgeKind::Dep(DepKind::Build));
result.insert(EdgeKind::Dep(DepKind::Development));
};
let unknown = |k| {
bail!(
"unknown edge kind `{}`, valid values are \
\"normal\", \"build\", \"dev\", \
\"no-normal\", \"no-build\", \"no-dev\", \"no-proc-macro\", \
\"features\", or \"all\"",
k
)
};
if kinds.iter().any(|k| k.starts_with("no-")) {
insert_defaults(&mut result);
for kind in &kinds {
Expand All @@ -330,7 +333,7 @@ fn parse_edge_kinds(
kind
)
}
k => return unknown(k),
_ => unreachable!("`{kind}` was validated by clap"),
};
}
return Ok((result, no_proc_macro, public));
Expand All @@ -353,7 +356,7 @@ fn parse_edge_kinds(
"dev" => {
result.insert(EdgeKind::Dep(DepKind::Development));
}
k => return unknown(k),
_ => unreachable!("`{kind}` was validated by clap"),
}
}
if kinds.len() == 1 && kinds[0] == "features" {
Expand Down
7 changes: 5 additions & 2 deletions tests/testsuite/cargo_tree/deps.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1723,10 +1723,13 @@ fn unknown_edge_kind() {

p.cargo("tree -e unknown")
.with_stderr_data(str![[r#"
[ERROR] unknown edge kind `unknown`, valid values are "normal", "build", "dev", "no-normal", "no-build", "no-dev", "no-proc-macro", "features", or "all"
[ERROR] invalid value 'unknown' for '--edges <KINDS>'
[possible values: all, normal, build, dev, features, public, no-normal, no-build, no-dev, no-proc-macro]
For more information, try '--help'.
"#]])
.with_status(101)
.with_status(1)
.run();
}

Expand Down
Loading