Skip to content

Commit 11c0ae1

Browse files
committed
fix(help): Render partially optional values with []
Fixes: #4847
1 parent 3fa7b8f commit 11c0ae1

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

clap_builder/src/builder/arg.rs

+6-2
Original file line numberDiff line numberDiff line change
@@ -4364,7 +4364,11 @@ impl Arg {
43644364

43654365
debug_assert!(self.is_takes_value_set());
43664366
for (n, val_name) in val_names.iter().enumerate() {
4367-
let arg_name = if self.is_positional() && (num_vals.min_values() == 0 || !required) {
4367+
let all_optional = self.get_min_vals() == 0;
4368+
let arg_name = if match self.is_positional() {
4369+
true => num_vals.min_values() == 0 || !required,
4370+
false => !all_optional && (n + 1 > num_vals.min_values()),
4371+
} {
43684372
format!("[{val_name}]")
43694373
} else {
43704374
format!("<{val_name}>")
@@ -4646,7 +4650,7 @@ mod test {
46464650
.value_names(["file", "name"]);
46474651
o._build();
46484652

4649-
assert_eq!(o.to_string(), "-o <file> <name>...");
4653+
assert_eq!(o.to_string(), "-o <file> [name]...");
46504654
}
46514655

46524656
#[test]

tests/builder/help.rs

+21
Original file line numberDiff line numberDiff line change
@@ -2845,3 +2845,24 @@ fn display_name_subcommand_explicit() {
28452845
Some("child.display")
28462846
);
28472847
}
2848+
2849+
#[test]
2850+
fn issue_4847_usage() {
2851+
static USAGE_WITH_GROUP: &str = "\
2852+
Usage: deno [OPTIONS]
2853+
2854+
Options:
2855+
--example <REQUIRED> [OPTIONAL] issue 4847
2856+
-h, --help Print help
2857+
";
2858+
2859+
let cmd = clap::Command::new("hello").bin_name("deno").arg(
2860+
Arg::new("example")
2861+
.long("example")
2862+
.num_args(1..=2)
2863+
.help("issue 4847")
2864+
.value_names(&["REQUIRED", "OPTIONAL"]),
2865+
);
2866+
2867+
utils::assert_output(cmd, "deno --help", USAGE_WITH_GROUP, false);
2868+
}

0 commit comments

Comments
 (0)