-
-
Notifications
You must be signed in to change notification settings - Fork 1k
/
hidden_args.rs
304 lines (251 loc) · 7.58 KB
/
hidden_args.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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
use super::utils;
use clap::{arg, builder::PossibleValue, Arg, ArgAction, Command};
static HIDDEN_ARGS: &str = "\
tests stuff
Usage: test [OPTIONS]
Options:
-F, --flag2 some other flag
--option <opt> some option
-h, --help Print help
-V, --version Print version
";
#[test]
fn hide_args() {
let cmd = Command::new("test")
.author("Kevin K.")
.about("tests stuff")
.version("1.4")
.args([
arg!(-f --flag "some flag").hide(true),
arg!(-F --flag2 "some other flag"),
arg!(--option <opt> "some option"),
Arg::new("DUMMY").hide(true),
]);
utils::assert_output(cmd, "test --help", HIDDEN_ARGS, false);
}
static HIDDEN_SHORT_ARGS: &str = "\
hides short args
Usage: test [OPTIONS]
Options:
-v, --visible This text should be visible
-h, --help Print help (see more with '--help')
-V, --version Print version
";
/// Ensure hide with short option
#[test]
fn hide_short_args() {
let cmd = Command::new("test")
.about("hides short args")
.author("Steve P.")
.version("2.31.2")
.args([
Arg::new("cfg")
.short('c')
.long("config")
.hide_short_help(true)
.action(ArgAction::SetTrue)
.help("Some help text describing the --config arg"),
Arg::new("visible")
.short('v')
.long("visible")
.action(ArgAction::SetTrue)
.help("This text should be visible"),
]);
utils::assert_output(cmd, "test -h", HIDDEN_SHORT_ARGS, false);
}
/// Ensure visible with opposite option
#[test]
fn hide_short_args_long_help() {
static HIDDEN_SHORT_ARGS_LONG_HELP: &str = "\
hides short args
Usage: test [OPTIONS]
Options:
-c, --config
Some help text describing the --config arg
-v, --visible
This text should be visible
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
";
let cmd = Command::new("test")
.about("hides short args")
.author("Steve P.")
.version("2.31.2")
.args([
Arg::new("cfg")
.short('c')
.long("config")
.hide_short_help(true)
.action(ArgAction::SetTrue)
.help("Some help text describing the --config arg"),
Arg::new("visible")
.short('v')
.long("visible")
.action(ArgAction::SetTrue)
.help("This text should be visible"),
]);
utils::assert_output(cmd, "test --help", HIDDEN_SHORT_ARGS_LONG_HELP, false);
}
static HIDDEN_LONG_ARGS: &str = "\
hides long args
Usage: test [OPTIONS]
Options:
-v, --visible
This text should be visible
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
";
#[test]
fn hide_long_args() {
let cmd = Command::new("test")
.about("hides long args")
.author("Steve P.")
.version("2.31.2")
.args([
Arg::new("cfg")
.short('c')
.long("config")
.hide_long_help(true)
.action(ArgAction::SetTrue)
.help("Some help text describing the --config arg"),
Arg::new("visible")
.short('v')
.long("visible")
.action(ArgAction::SetTrue)
.help("This text should be visible"),
]);
utils::assert_output(cmd, "test --help", HIDDEN_LONG_ARGS, false);
}
static HIDDEN_LONG_ARGS_SHORT_HELP: &str = "\
hides long args
Usage: test [OPTIONS]
Options:
-c, --config Some help text describing the --config arg
-v, --visible This text should be visible
-h, --help Print help (see more with '--help')
-V, --version Print version
";
#[test]
fn hide_long_args_short_help() {
let cmd = Command::new("test")
.about("hides long args")
.author("Steve P.")
.version("2.31.2")
.args([
Arg::new("cfg")
.short('c')
.long("config")
.hide_long_help(true)
.action(ArgAction::SetTrue)
.help("Some help text describing the --config arg"),
Arg::new("visible")
.short('v')
.long("visible")
.action(ArgAction::SetTrue)
.help("This text should be visible"),
]);
utils::assert_output(cmd, "test -h", HIDDEN_LONG_ARGS_SHORT_HELP, false);
}
static HIDDEN_POS_ARGS: &str = "\
Usage: test [another]
Arguments:
[another] another pos
Options:
-h, --help Print help
-V, --version Print version
";
#[test]
fn hide_pos_args() {
let cmd = Command::new("test").version("1.4").args([
Arg::new("pos").help("some pos").hide(true),
Arg::new("another").help("another pos"),
]);
utils::assert_output(cmd, "test --help", HIDDEN_POS_ARGS, false);
}
static HIDDEN_SUBCMDS: &str = "\
Usage: test
Options:
-h, --help Print help
-V, --version Print version
";
#[test]
fn hide_subcmds() {
let cmd = Command::new("test")
.version("1.4")
.subcommand(Command::new("sub").hide(true));
utils::assert_output(cmd, "test --help", HIDDEN_SUBCMDS, false);
}
static HIDDEN_OPT_ARGS_ONLY: &str = "\
Usage: test
After help
";
#[test]
fn hide_opt_args_only() {
let cmd = Command::new("test")
.version("1.4")
.after_help("After help")
.disable_help_flag(true)
.disable_version_flag(true)
.arg(arg!(-h - -help).action(ArgAction::Help).hide(true))
.arg(arg!(-v - -version).hide(true))
.arg(arg!(--option <opt> "some option").hide(true));
utils::assert_output(cmd, "test --help", HIDDEN_OPT_ARGS_ONLY, false);
}
static HIDDEN_POS_ARGS_ONLY: &str = "\
Usage: test
After help
";
#[test]
fn hide_pos_args_only() {
let cmd = Command::new("test")
.version("1.4")
.after_help("After help")
.disable_help_flag(true)
.disable_version_flag(true)
.arg(arg!(-h - -help).action(ArgAction::Help).hide(true))
.arg(arg!(-v - -version).hide(true))
.args([Arg::new("pos").help("some pos").hide(true)]);
utils::assert_output(cmd, "test --help", HIDDEN_POS_ARGS_ONLY, false);
}
static HIDDEN_SUBCMDS_ONLY: &str = "\
Usage: test
After help
";
#[test]
fn hide_subcmds_only() {
let cmd = Command::new("test")
.version("1.4")
.after_help("After help")
.disable_help_flag(true)
.disable_version_flag(true)
.arg(arg!(-h - -help).action(ArgAction::Help).hide(true))
.arg(arg!(-v - -version).hide(true))
.subcommand(Command::new("sub").hide(true));
utils::assert_output(cmd, "test --help", HIDDEN_SUBCMDS_ONLY, false);
}
#[test]
fn hidden_arg_with_possible_value_with_help() {
// Normally the presence of a possible value with a help text triggers a
// change of the --help help text by appending `(see more with '--help')`
// or `(see a summary with '-h')`. When the argument is completely hidden
// we however do not want it to trigger that change.
static POS_VALS_HELP: &str = "\
Usage: ctest
Options:
-h, --help Print help
";
let app = Command::new("ctest").arg(
Arg::new("pos")
.hide(true)
.value_parser([
PossibleValue::new("fast"),
PossibleValue::new("slow").help("not as fast"),
])
.action(ArgAction::Set),
);
utils::assert_output(app, "ctest --help", POS_VALS_HELP, false);
}