fix(help): Align mixed argument types

BrandonXLF · BrandonXLF · commit 0f7dbbc27ecf · 2025-03-31T21:29:24.000-04:00
Fixes #3835
diff --git a/clap_builder/src/output/help_template.rs b/clap_builder/src/output/help_template.rs
@@ -480,7 +480,13 @@ impl HelpTemplate<'_, '_> {
             should_show_arg(self.use_long, arg)
         }) {
             if longest_filter(arg) {
-                longest = longest.max(display_width(&arg.to_string()));
+                let width = display_width(&arg.to_string());
+                let actual_width = if arg.is_positional() {
+                    width
+                } else {
+                    width + SHORT_SIZE
+                };
+                longest = longest.max(actual_width);
                 debug!(
                     "HelpTemplate::write_args: arg={:?} longest={}",
                     arg.get_id(),
@@ -569,7 +575,7 @@ impl HelpTemplate<'_, '_> {
             debug!("HelpTemplate::align_to_about: printing long help so skip alignment");
             0
         } else if !arg.is_positional() {
-            let self_len = display_width(&arg.to_string());
+            let self_len = display_width(&arg.to_string()) + SHORT_SIZE;
             // Since we're writing spaces from the tab point we first need to know if we
             // had a long and short, or just short
             let padding = if arg.get_long().is_some() {
@@ -622,10 +628,8 @@ impl HelpTemplate<'_, '_> {
 
         let spaces = if next_line_help {
             TAB.len() + NEXT_LINE_INDENT.len()
-        } else if arg.map(|a| a.is_positional()).unwrap_or(true) {
-            longest + TAB_WIDTH * 2
         } else {
-            longest + TAB_WIDTH * 2 + SHORT_SIZE
+            longest + TAB_WIDTH * 2
         };
         let trailing_indent = spaces; // Don't indent any further than the first line is indented
         let trailing_indent = self.get_spaces(trailing_indent);
@@ -726,11 +730,7 @@ impl HelpTemplate<'_, '_> {
                 .or_else(|| arg.get_long_help())
                 .unwrap_or_default();
             let h_w = h.display_width() + display_width(spec_vals);
-            let taken = if arg.is_positional() {
-                longest + TAB_WIDTH * 2
-            } else {
-                longest + TAB_WIDTH * 2 + SHORT_SIZE
-            };
+            let taken = longest + TAB_WIDTH * 2;
             self.term_w >= taken
                 && (taken as f32 / self.term_w as f32) > 0.40
                 && h_w > (self.term_w - taken)
diff --git a/examples/git-derive.md b/examples/git-derive.md
@@ -87,12 +87,12 @@ git-derive[EXE] stash push:
   -h, --help               Print help
 
 git-derive[EXE] stash pop:
-  -h, --help   Print help
-  [STASH]  
+  -h, --help  Print help
+  [STASH]     
 
 git-derive[EXE] stash apply:
-  -h, --help   Print help
-  [STASH]  
+  -h, --help  Print help
+  [STASH]     
 
 git-derive[EXE] stash help:
 Print this message or the help of the given subcommand(s)
diff --git a/examples/git.md b/examples/git.md
@@ -85,12 +85,12 @@ git[EXE] stash push:
   -h, --help               Print help
 
 git[EXE] stash pop:
-  -h, --help   Print help
-  [STASH]  
+  -h, --help  Print help
+  [STASH]     
 
 git[EXE] stash apply:
-  -h, --help   Print help
-  [STASH]  
+  -h, --help  Print help
+  [STASH]     
 
 git[EXE] stash help:
 Print this message or the help of the given subcommand(s)
diff --git a/tests/builder/help.rs b/tests/builder/help.rs
@@ -3986,8 +3986,8 @@ Options:
   -h, --help  Print help
 
 Mixed:
-  -b, --both        Both long and short
-      --long        Long only
+  -b, --both    Both long and short
+      --long    Long only
   <POSITIONAL>  Positional
 
 "#]];
@@ -4014,7 +4014,7 @@ Options:
 Mixed:
   -b, --both  Both long and short
       --long  Long only
-  <S>     Short positional
+  <S>         Short positional
 
 "#]];
     utils::assert_output(cmd, "myprog --help", expected, false);
@@ -4037,7 +4037,7 @@ Options:
   -h, --help  Print help
 
 Mixed:
-      --long        Long only
+      --long    Long only
   <POSITIONAL>  Positional
 
 "#]];
