Merge pull request #5084 from epage/newline

epage · web-flow · commit 42a11caa5ef7 · 2023-08-23T09:20:12.000-05:00
fix(help): Ensure padding isn't stripped
diff --git a/clap_builder/src/builder/styled_str.rs b/clap_builder/src/builder/styled_str.rs
@@ -1,3 +1,5 @@
+#![cfg_attr(not(feature = "usage"), allow(dead_code))]
+
 /// Terminal-styling container
 ///
 /// Styling may be encoded as [ANSI Escape Code](https://en.wikipedia.org/wiki/ANSI_escape_code)
@@ -47,6 +49,19 @@ impl StyledStr {
         self.0 = self.0.trim().to_owned()
     }
 
+    pub(crate) fn trim_start_lines(&mut self) {
+        if let Some(pos) = self.0.find('\n') {
+            let (leading, help) = self.0.split_at(pos + 1);
+            if leading.trim().is_empty() {
+                self.0 = help.to_owned()
+            }
+        }
+    }
+
+    pub(crate) fn trim_end(&mut self) {
+        self.0 = self.0.trim_end().to_owned()
+    }
+
     #[cfg(feature = "help")]
     pub(crate) fn replace_newline_var(&mut self) {
         self.0 = self.0.replace("{n}", "\n");
diff --git a/clap_builder/src/output/help.rs b/clap_builder/src/output/help.rs
@@ -30,8 +30,10 @@ pub(crate) fn write_help(writer: &mut StyledStr, cmd: &Command, usage: &Usage<'_
         }
     }
 
-    // Remove any extra lines caused by book keeping
-    writer.trim();
+    // Remove any lines from unused sections
+    writer.trim_start_lines();
+    // Remove any whitespace caused by book keeping
+    writer.trim_end();
     // Ensure there is still a trailing newline
     writer.push_str("\n");
 }
diff --git a/tests/builder/help.rs b/tests/builder/help.rs
@@ -1333,6 +1333,23 @@ Options:
     utils::assert_output(cmd, "ctest --help", ISSUE_777, false);
 }
 
+#[test]
+fn dont_strip_padding_issue_5083() {
+    let cmd = Command::new("test")
+        .help_template("{subcommands}")
+        .subcommands([
+            Command::new("one"),
+            Command::new("two"),
+            Command::new("three"),
+        ]);
+    static EXPECTED: &str = "  one    
+  two    
+  three  
+  help   Print this message or the help of the given subcommand(s)
+";
+    utils::assert_output(cmd, "test --help", EXPECTED, false);
+}
+
 static OVERRIDE_HELP_SHORT: &str = "\
 Usage: test
 

Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,10 @@ pub(crate) fn write_help(writer: &mut StyledStr, cmd: &Command, usage: &Usage<'_`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`
`33`		`- // Remove any extra lines caused by book keeping`
`34`		`- writer.trim();`
	`33`	`+ // Remove any lines from unused sections`
	`34`	`+ writer.trim_start_lines();`
	`35`	`+ // Remove any whitespace caused by book keeping`
	`36`	`+ writer.trim_end();`
`35`	`37`	`// Ensure there is still a trailing newline`
`36`	`38`	`writer.push_str("\n");`
`37`	`39`	`}`