-
Notifications
You must be signed in to change notification settings - Fork 17
/
markdown.rs
256 lines (193 loc) · 4.91 KB
/
markdown.rs
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
#![cfg(feature = "docgen")]
#![allow(dead_code)]
use bpaf::*;
fn write_updated(new_val: &str, path: impl AsRef<std::path::Path>) -> std::io::Result<bool> {
use std::io::Read;
use std::io::Seek;
let mut file = std::fs::OpenOptions::new()
.write(true)
.read(true)
.create(true)
.open(path)?;
let mut current_val = String::new();
file.read_to_string(&mut current_val)?;
if current_val != new_val {
file.set_len(0)?;
file.seek(std::io::SeekFrom::Start(0))?;
std::io::Write::write_all(&mut file, new_val.as_bytes())?;
Ok(false)
} else {
Ok(true)
}
}
#[test]
fn simple() {
let kraken = short('d')
.long("kraken")
.help("Unleash the kraken")
.switch();
let user = long("user")
.env("USER")
.help("Log in as this user")
.argument::<String>("USER");
let options = construct!(kraken, user)
.to_options()
.descr("I am a program and I do things")
.header("Sometimes they even work.")
.footer("Beware `-d`, dragons be here");
let roff = options.render_markdown("simple");
#[cfg(unix)]
assert!(write_updated(&roff, "tests/markdown.md").unwrap());
}
#[test]
fn nested() {
#[derive(Debug, Clone, Bpaf)]
/// Options
#[bpaf(options)]
enum Options {
#[bpaf(command)]
/// Alpha
Alpha,
#[bpaf(command)]
/// Beta
///
/// More Beta
///
/// Even More Beta
Beta,
}
let r = options().render_markdown("options");
let expected = "
# Command summary
* [`options`↴](#options)
* [`options alpha`↴](#options-alpha)
* [`options beta`↴](#options-beta)
## options
Options
**Usage**: **`options`** _`COMMAND ...`_
**Available options:**
- **`-h`**, **`--help`** — \n Prints help information
**Available commands:**
- **`alpha`** — \n Alpha
- **`beta`** — \n Beta
## options alpha
Alpha
**Usage**: **`options`** **`alpha`** \n
**Available options:**
- **`-h`**, **`--help`** — \n Prints help information
## options beta
Beta
More Beta
Even More Beta
**Usage**: **`options`** **`beta`** \n
**Available options:**\n- **`-h`**, **`--help`** — \n Prints help information
";
assert_eq!(r, expected);
}
#[test]
fn multi_line_help() {
let opts = short('a').help("help\n\nmore help").switch().to_options();
let r = opts.render_markdown("ml");
let expected = "\
# ml
**Usage**: **`ml`** \\[**`-a`**\\]
**Available options:**
- **`-a`** — \n help
more help
- **`-h`**, **`--help`** — \n Prints help information
";
assert_eq!(r, expected);
}
#[test]
fn no_help() {
let a = short('a').help("help").switch();
let b = short('b').switch();
let opts = construct!(a, b).to_options();
let r = opts.render_markdown("ml");
let expected = "\
# ml
**Usage**: **`ml`** \\[**`-a`**\\] \\[**`-b`**\\]
**Available options:**
- **`-a`** — \n help
- **`-b`**\n- **`-h`**, **`--help`** — \n Prints help information\n\n\n";
assert_eq!(r, expected);
}
#[test]
fn codeblock_space_help() {
#[derive(Bpaf, Clone, Debug)]
#[bpaf(options)]
struct Options {
/// Verbose help
///
/// block
/// of
/// code
verbose: bool,
}
let r = options().run_inner(&["-hh"]).unwrap_err().unwrap_stdout();
let expected = "\
Usage: [--verbose]
Available options:
--verbose Verbose help
block
of
code
-h, --help Prints help information
";
assert_eq!(r, expected);
let r = options().render_markdown("ml");
let expected = "\
# ml
**Usage**: **`ml`** \\[**`--verbose`**\\]
**Available options:**
- **` --verbose`** — \n Verbose help
\n
```text
block
of
code
```
- **`-h`**, **`--help`** — \n Prints help information\n\n\n";
assert_eq!(r, expected);
}
#[test]
fn codeblock_ticks_help() {
#[derive(Bpaf, Clone, Debug)]
#[bpaf(options)]
struct Options {
/// Verbose help
///
/// ```text
/// block
/// of
/// code
/// ```
verbose: bool,
}
let r = options().run_inner(&["-hh"]).unwrap_err().unwrap_stdout();
let expected = "\
Usage: [--verbose]
Available options:
--verbose Verbose help
```text
block
of
code
```
-h, --help Prints help information
";
assert_eq!(r, expected);
let r = options().render_markdown("ml");
let expected = "\
# ml
**Usage**: **`ml`** \\[**`--verbose`**\\]
**Available options:**
- **` --verbose`** — \n Verbose help
\n ```text
block
of
code
```
- **`-h`**, **`--help`** — \n Prints help information\n\n\n";
assert_eq!(r, expected);
}