bpaf 0.9.25

A simple Command Line Argument Parser with parser combinators
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152


```no_run
#[derive(Debug, Clone)]
pub struct Options {
    package: Option<String>,
}

pub fn options() -> OptionParser<Options> {
    let help = long("help").short('H').help("Renders help information");
    let version = long("version")
        .short('v')
        .help("Renders version information");
    let package = short('p')
        .help("Package to check")
        .argument("SPEC")
        .optional();

    construct!(Options { package })
        .to_options()
        .descr("Command with custom flags for help and version")
        .version("0.42")
        .help_parser(help)
        .version_parser(version)
}

fn main() {
    println!("{:?}", options().run())
}
```

<details><summary>Output</summary>

This example replaces description and short name for `--help` parser. Long name works as is


<div class='bpaf-doc'>
$ app --help<br>
<p>Command with custom flags for help and version</p><p><b>Usage</b>: <tt><b>app</b></tt> [<tt><b>-p</b></tt>=<tt><i>SPEC</i></tt>]</p><p><div>
<b>Available options:</b></div><dl><dt><tt><b>-p</b></tt>=<tt><i>SPEC</i></tt></dt>
<dd>Package to check</dd>
<dt><tt><b>-H</b></tt>, <tt><b>--help</b></tt></dt>
<dd>Renders help information</dd>
<dt><tt><b>-v</b></tt>, <tt><b>--version</b></tt></dt>
<dd>Renders version information</dd>
</dl>
</p>
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>


Short name is now capitalized


<div class='bpaf-doc'>
$ app -H<br>
<p>Command with custom flags for help and version</p><p><b>Usage</b>: <tt><b>app</b></tt> [<tt><b>-p</b></tt>=<tt><i>SPEC</i></tt>]</p><p><div>
<b>Available options:</b></div><dl><dt><tt><b>-p</b></tt>=<tt><i>SPEC</i></tt></dt>
<dd>Package to check</dd>
<dt><tt><b>-H</b></tt>, <tt><b>--help</b></tt></dt>
<dd>Renders help information</dd>
<dt><tt><b>-v</b></tt>, <tt><b>--version</b></tt></dt>
<dd>Renders version information</dd>
</dl>
</p>
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>


and old short name no longer works.


<div class='bpaf-doc'>
$ app -h<br>
<b>Error:</b> <b>-h</b> is not expected in this context
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>


Same with `--version` parser - new description, original long name and custom short name are
both working


<div class='bpaf-doc'>
$ app --version<br>
<p>Version: 0.42</p>
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>



<div class='bpaf-doc'>
$ app -v<br>
<p>Version: 0.42</p>
<style>
div.bpaf-doc {
    padding: 14px;
    background-color:var(--code-block-background-color);
    font-family: "Source Code Pro", monospace;
    margin-bottom: 0.75em;
}
div.bpaf-doc dt { margin-left: 1em; }
div.bpaf-doc dd { margin-left: 3em; }
div.bpaf-doc dl { margin-top: 0; padding-left: 1em; }
div.bpaf-doc  { padding-left: 1em; }
</style>
</div>

</details>