fix(help): Correctly calculate wrap points with ANSI escape codes

epage · epage · commit 26407628529d · 2025-10-13T10:48:13.000-05:00
We mixed up whether `i` represented the absolute position or our incremental position. Fixes #6147
diff --git a/clap_builder/src/builder/styled_str.rs b/clap_builder/src/builder/styled_str.rs
@@ -240,6 +240,9 @@ mod wrap_tests {
         let mut actual = StyledStr::new();
         actual.push_string(input);
         actual.wrap(20);
-        assert_data_eq!(actual.ansi().to_string(), str!["[1m12345[0m [1m12345[0m [1m12345[0m [1m12345[0m"]);
+        assert_data_eq!(actual.ansi().to_string(), str![[r#"
+[1m12345[0m [1m12345[0m [1m12345[0m [1m
+12345[0m
+"#]]);
     }
 }
diff --git a/clap_builder/src/output/textwrap/mod.rs b/clap_builder/src/output/textwrap/mod.rs
@@ -92,7 +92,7 @@ mod test {
         // will be empty. This is because the string is split into
         // words like [" ", "foobar ", "baz"], which puts "foobar " on
         // the second line. We never output trailing whitespace
-        assert_eq!(wrap(" foobar baz", 6), vec!["", " foobar", " baz"]);
+        assert_eq!(wrap(" foobar baz", 6), vec![" foobar", " baz"]);
     }
 
     #[test]
diff --git a/clap_builder/src/output/textwrap/wrap_algorithms.rs b/clap_builder/src/output/textwrap/wrap_algorithms.rs
@@ -22,7 +22,9 @@ impl<'w> LineWrapper<'w> {
     }
 
     pub(crate) fn wrap(&mut self, mut words: Vec<&'w str>) -> Vec<&'w str> {
+        let mut first_word = false;
         if self.indentation.is_none() {
+            first_word = true;
             if let Some(word) = words.first() {
                 if word.trim().is_empty() {
                     self.indentation = Some(*word);
@@ -38,7 +40,10 @@ impl<'w> LineWrapper<'w> {
             let trimmed = word.trim_end();
             let word_width = display_width(trimmed);
             let trimmed_delta = word.len() - trimmed.len();
-            if i != 0 && self.hard_width < self.line_width + word_width {
+            if first_word && 0 < word_width {
+                // Never try to wrap the first word
+                first_word = false;
+            } else if self.hard_width < self.line_width + word_width {
                 if 0 < i {
                     let prev = i - 1;
                     let trimmed = words[prev].trim_end();
diff --git a/tests/ui/arg_required_else_help_stderr.toml b/tests/ui/arg_required_else_help_stderr.toml
@@ -9,9 +9,11 @@ Commands:
   more                    
   test                    Subcommand with one visible alias [aliases: do-stuff]
   test_2                  several visible aliases [aliases: do-other-stuff, tests]
-  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, --test_all]
+  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, 
+                          --test_all]
   test_4, -t              several visible short flag aliases [aliases: -q, -w]
-  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k]
+  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k
+                          ]
   help                    Print this message or the help of the given subcommand(s)
 
 Arguments:
diff --git a/tests/ui/h_flag_stdout.toml b/tests/ui/h_flag_stdout.toml
@@ -8,9 +8,11 @@ Commands:
   more                    
   test                    Subcommand with one visible alias [aliases: do-stuff]
   test_2                  several visible aliases [aliases: do-other-stuff, tests]
-  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, --test_all]
+  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, 
+                          --test_all]
   test_4, -t              several visible short flag aliases [aliases: -q, -w]
-  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k]
+  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k
+                          ]
   help                    Print this message or the help of the given subcommand(s)
 
 Arguments:
diff --git a/tests/ui/help_cmd_stdout.toml b/tests/ui/help_cmd_stdout.toml
@@ -8,9 +8,11 @@ Commands:
   more                    
   test                    Subcommand with one visible alias [aliases: do-stuff]
   test_2                  several visible aliases [aliases: do-other-stuff, tests]
-  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, --test_all]
+  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, 
+                          --test_all]
   test_4, -t              several visible short flag aliases [aliases: -q, -w]
-  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k]
+  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k
+                          ]
   help                    Print this message or the help of the given subcommand(s)
 
 Arguments:
diff --git a/tests/ui/help_flag_stdout.toml b/tests/ui/help_flag_stdout.toml
@@ -8,9 +8,11 @@ Commands:
   more                    
   test                    Subcommand with one visible alias [aliases: do-stuff]
   test_2                  several visible aliases [aliases: do-other-stuff, tests]
-  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, --test_all]
+  test_3, --test          several visible long flag aliases [aliases: --testing, --testall, 
+                          --test_all]
   test_4, -t              several visible short flag aliases [aliases: -q, -w]
-  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k]
+  test_5, -e, --test-hdr  all kinds of visible aliases [aliases: -r, -y, --thetests, --t4k, tests_4k
+                          ]
   help                    Print this message or the help of the given subcommand(s)
 
 Arguments:

Original file line number	Diff line number	Diff line change
`@@ -240,6 +240,9 @@ mod wrap_tests {`
`240`	`240`	`let mut actual = StyledStr::new();`
`241`	`241`	`actual.push_string(input);`
`242`	`242`	`actual.wrap(20);`
`243`		`- assert_data_eq!(actual.ansi().to_string(), str!["[1m12345[0m [1m12345[0m [1m12345[0m [1m12345[0m"]);`
	`243`	`+ assert_data_eq!(actual.ansi().to_string(), str![[r#"`
	`244`	`+[1m12345[0m [1m12345[0m [1m12345[0m [1m`
	`245`	`+12345[0m`
	`246`	`+"#]]);`
`244`	`247`	`}`
`245`	`248`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ mod test {`
`92`	`92`	`// will be empty. This is because the string is split into`
`93`	`93`	`// words like [" ", "foobar ", "baz"], which puts "foobar " on`
`94`	`94`	`// the second line. We never output trailing whitespace`
`95`		`- assert_eq!(wrap(" foobar baz", 6), vec!["", " foobar", " baz"]);`
	`95`	`+ assert_eq!(wrap(" foobar baz", 6), vec![" foobar", " baz"]);`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`#[test]`