Merge pull request #449 from pacak/rc-0.9.25

Release 0.9.25

Author: pacak

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bpaf"
-version = "0.9.24"
+version = "0.9.25"
 edition = "2021"
 categories = ["command-line-interface"]
 description = "A simple Command Line Argument Parser with parser combinators"

Changelog.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## bpaf [0.9.25] - 2026-04-15
+- Change rendering of an adjacent block in Markdown - this is no longer a `###`
+  but a regular line item instead. Header messes up with generated navigation on
+  some pages
+- `app_name` - parser that extracts the executable name
+
 ## bpaf [0.9.24] - 2026-03-13
 - a less confusing error message when invalid user input mixes with parsers that
   can succeed with no input, see #442

docs2/src/appname/cases.md

@@ -0,0 +1,7 @@
+Parsed application name doesn't show up in the `--help` output
+
+> --help
+
+but simply produces the app name, when it is available
+
+> --user=Bob

docs2/src/appname/combine.rs

@@ -0,0 +1,18 @@
+//
+use bpaf::*;
+#[derive(Debug, Clone)]
+pub struct Options {
+    user: String,
+    appname: String,
+}
+
+pub fn options() -> OptionParser<Options> {
+    let user = short('u')
+        .long("user")
+        .help("Specify user name")
+        // you can specify exact type argument should produce
+        // for as long as it implements `FromStr`
+        .argument::<String>("NAME");
+
+    construct!(Options { user, appname() }).to_options()
+}

docs2/src/appname/derive.rs

@@ -0,0 +1,13 @@
+//
+use bpaf::*;
+#[derive(Debug, Clone, Bpaf)]
+#[bpaf(options)]
+pub struct Options {
+    /// Specify user name
+    #[bpaf(short, long, argument::<String>("NAME"))]
+    user: String,
+
+    /// Specify user age
+    #[bpaf(external)]
+    appname: String,
+}

examples/app_name.rs

@@ -0,0 +1,22 @@
+use bpaf::*;
+#[derive(Debug, Clone)]
+pub struct Options {
+    user: String,
+    appname: String,
+}
+
+pub fn options() -> OptionParser<Options> {
+    let user = short('u')
+        .long("user")
+        .help("Specify user name")
+        // you can specify exact type argument should produce
+        // for as long as it implements `FromStr`
+        .argument::<String>("NAME");
+
+    construct!(Options { user, appname() }).to_options()
+}
+
+fn main() {
+    let opts = options().run();
+    println!("{opts:?}");
+}

src/buffer.rs

@@ -275,6 +275,10 @@ pub(crate) enum Block {
     /// level 3 section header, "group_help" header, etc.
     Section3,
 
+    // 2 margin
+    /// Same as level 3, but with no `###` in markdown
+    Section4,
+
     // inline, 4 margin, no nesting
     /// -h, --help
     ItemTerm,

src/buffer/console.rs

@@ -271,7 +271,7 @@ impl Doc {
                             pending_newline = true;
                             margins.push(margin);
                         }
-                        Block::Section3 => {
+                        Block::Section3 | Block::Section4 => {
                             pending_newline = true;
                             margins.push(margin + 2);
                         }
@@ -310,6 +310,7 @@ impl Doc {
                         Block::Header
                         | Block::Section2
                         | Block::Section3
+                        | Block::Section4
                         | Block::ItemTerm
                         | Block::DefinitionList
                         | Block::Meta

src/buffer/html.rs

@@ -259,7 +259,9 @@ impl Doc {
                             res.push_str("<p>");
                         }
                         Block::Meta => todo!(),
-                        Block::Section3 => res.push_str("<div style='padding-left: 0.5em'>"),
+                        Block::Section3 | Block::Section4 => {
+                            res.push_str("<div style='padding-left: 0.5em'>")
+                        }
                         Block::Mono | Block::TermRef => {}
                         Block::InlineBlock => {
                             skip.push();
@@ -294,7 +296,7 @@ impl Doc {
                             res.push_str("</p>");
                         }
                         Block::Mono | Block::TermRef => {}
-                        Block::Section3 => res.push_str("</div>"),
+                        Block::Section3 | Block::Section4 => res.push_str("</div>"),
                         Block::Meta => todo!(),
                     }
                 }
@@ -395,7 +397,7 @@ impl Doc {
                         Block::Section2 => {
                             res.push_str("");
                         }
-                        Block::ItemTerm => {
+                        Block::ItemTerm | Block::Section4 => {
                             new_markdown_line(&mut res);
                             empty_term = matches!(
                                 self.tokens.get(ix + 1),
@@ -431,7 +433,11 @@ impl Doc {
                 Token::BlockEnd(b) => {
                     change_to_markdown_style(&mut res, &mut cur_style, Styles::default());
                     match b {
-                        Block::Header | Block::Block | Block::Section3 | Block::Section2 => {
+                        Block::Header
+                        | Block::Block
+                        | Block::Section3
+                        | Block::Section2
+                        | Block::Section4 => {
                             res.push('\n');
                         }
 

src/buffer/manpage.rs

@@ -190,7 +190,7 @@ impl Doc {
                 Token::BlockStart(block) => {
                     //
                     match block {
-                        Block::Header | Block::Section2 | Block::Section3 => {
+                        Block::Header | Block::Section2 | Block::Section3 | Block::Section4 => {
                             capture.1 = true;
                         }
                         Block::ItemTerm => {
@@ -218,7 +218,7 @@ impl Doc {
                             roff.control("SH", [capture.0.to_uppercase()]);
                             capture.0.clear();
                         }
-                        Block::Section2 | Block::Section3 => {
+                        Block::Section2 | Block::Section3 | Block::Section4 => {
                             capture.1 = false;
                             roff.control("SS", [capture.0.to_uppercase()]);
                             capture.0.clear();