Merge pull request #3587 from ducaale/value-name-as-header-positional

Use `Arg::value_name()` as header for positionals in clap_mangen
clap-rs · Apr 4, 2022 · 858f184 · 858f184
2 parents 871792e + fbfeaab
commit 858f184
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 8 deletions.
diff --git a/clap_mangen/src/render.rs b/clap_mangen/src/render.rs
@@ -61,7 +61,11 @@ pub(crate) fn synopsis(roff: &mut Roff, cmd: &clap::Command) {
     for arg in cmd.get_positionals() {
         let (lhs, rhs) = option_markers(arg);
         line.push(roman(lhs));
-        line.push(italic(arg.get_id()));
+        if let Some(value) = arg.get_value_names() {
+            line.push(italic(value.join(" ")));
+        } else {
+            line.push(italic(arg.get_id()));
+        }
         line.push(roman(rhs));
         line.push(roman(" "));
     }
@@ -84,8 +88,6 @@ pub(crate) fn options(roff: &mut Roff, cmd: &clap::Command) {
     let items: Vec<_> = cmd.get_arguments().filter(|i| !i.is_hide_set()).collect();
 
     for opt in items.iter().filter(|a| !a.is_positional()) {
-        let mut body = vec![];
-
         let mut header = match (opt.get_short(), opt.get_long()) {
             (Some(short), Some(long)) => {
                 vec![short_option(short), roman(", "), long_option(long)]
@@ -105,6 +107,7 @@ pub(crate) fn options(roff: &mut Roff, cmd: &clap::Command) {
             header.push(roman(&defs));
         }
 
+        let mut body = vec![];
         if let Some(help) = opt.get_long_help().or_else(|| opt.get_help()) {
             body.push(roman(help));
         }
@@ -119,17 +122,21 @@ pub(crate) fn options(roff: &mut Roff, cmd: &clap::Command) {
     }
 
     for pos in items.iter().filter(|a| a.is_positional()) {
+        let mut header = vec![];
         let (lhs, rhs) = option_markers(pos);
-        let name = format!("{}{}{}", lhs, pos.get_id(), rhs);
-
-        let mut header = vec![bold(&name)];
-
-        let mut body = vec![];
+        header.push(roman(lhs));
+        if let Some(value) = pos.get_value_names() {
+            header.push(italic(value.join(" ")));
+        } else {
+            header.push(italic(pos.get_id()));
+        };
+        header.push(roman(rhs));
 
         if let Some(defs) = option_default_values(pos) {
             header.push(roman(&format!(" {}", defs)));
         }
 
+        let mut body = vec![];
         if let Some(help) = pos.get_long_help().or_else(|| pos.get_help()) {
             body.push(roman(&help.to_string()));
         }
@@ -139,6 +146,7 @@ pub(crate) fn options(roff: &mut Roff, cmd: &clap::Command) {
         }
 
         roff.control("TP", []);
+        roff.text(header);
         roff.text(body);
     }
 }

diff --git a/clap_mangen/tests/snapshots/aliases.bash.roff b/clap_mangen/tests/snapshots/aliases.bash.roff
@@ -21,6 +21,7 @@ cmd flag
 /fB/-o/fR, /fB/-/-option/fR
 cmd option
 .TP
+[/fIpositional/fR]
 
 .SH VERSION
 v3.0
diff --git a/clap_mangen/tests/snapshots/feature_sample.bash.roff b/clap_mangen/tests/snapshots/feature_sample.bash.roff
@@ -18,8 +18,10 @@ Print version information
 /fB/-c/fR, /fB/-/-config/fR
 some config file
 .TP
+[/fIfile/fR]
 some input file
 .TP
+[/fIchoice/fR]
 
 .SH SUBCOMMANDS
 .TP

diff --git a/clap_mangen/tests/snapshots/special_commands.bash.roff b/clap_mangen/tests/snapshots/special_commands.bash.roff
@@ -18,8 +18,10 @@ Print version information
 /fB/-c/fR, /fB/-/-config/fR
 some config file
 .TP
+[/fIfile/fR]
 some input file
 .TP
+[/fIchoice/fR]
 
 .SH SUBCOMMANDS
 .TP

diff --git a/clap_mangen/tests/snapshots/sub_subcommands.bash.roff b/clap_mangen/tests/snapshots/sub_subcommands.bash.roff
@@ -18,8 +18,10 @@ Print version information
 /fB/-c/fR, /fB/-/-config/fR
 some config file
 .TP
+[/fIfile/fR]
 some input file
 .TP
+[/fIchoice/fR]
 
 .SH SUBCOMMANDS
 .TP

diff --git a/clap_mangen/tests/snapshots/value_hint.bash.roff b/clap_mangen/tests/snapshots/value_hint.bash.roff
@@ -50,4 +50,5 @@ Print help information
 /fB/-/-email/fR
 
 .TP
+[/fIcommand_with_args/fR]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -50,4 +50,5 @@ Print help information
		/fB/-/-email/fR

		.TP
		[/fIcommand_with_args/fR]