mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 06:42:33 +00:00
742aec292c
For version 3, we want the args section to immediately follow the usage section in the default help message. One change that I am unhappy with is needing to make "write_arg" in app/help.rs accept an extra param that makes it suppress the extra line. This is to prevent an extra blank line from appearing between args and options in the default help, and seems necessary, but there might be a better way.
146 lines
3.7 KiB
Rust
146 lines
3.7 KiB
Rust
extern crate clap;
|
|
extern crate regex;
|
|
|
|
use clap::{App, SubCommand};
|
|
|
|
include!("../clap-test.rs");
|
|
|
|
static EXAMPLE1_TMPL_S: &'static str = include_str!("example1_tmpl_simple.txt");
|
|
static EXAMPLE1_TMPS_F: &'static str = include_str!("example1_tmpl_full.txt");
|
|
|
|
static CUSTOM_TEMPL_HELP: &'static str = "MyApp 1.0
|
|
Kevin K. <kbknapp@gmail.com>
|
|
Does awesome things
|
|
|
|
USAGE:
|
|
MyApp [FLAGS] [OPTIONS] <output> [SUBCOMMAND]
|
|
|
|
FLAGS:
|
|
-d Turn debugging information on
|
|
-h, --help Prints help information
|
|
-V, --version Prints version information
|
|
OPTIONS:
|
|
-c, --config <FILE> Sets a custom config file
|
|
ARGS:
|
|
<output> Sets an optional output file
|
|
SUBCOMMANDS:
|
|
help Prints this message or the help of the given subcommand(s)
|
|
test does testing things";
|
|
|
|
static SIMPLE_TEMPLATE: &'static str = "MyApp 1.0
|
|
Kevin K. <kbknapp@gmail.com>
|
|
Does awesome things
|
|
|
|
USAGE:
|
|
MyApp [FLAGS] [OPTIONS] <output> [SUBCOMMAND]
|
|
|
|
ARGS:
|
|
<output> Sets an optional output file
|
|
|
|
FLAGS:
|
|
-d Turn debugging information on
|
|
-h, --help Prints help information
|
|
-V, --version Prints version information
|
|
|
|
OPTIONS:
|
|
-c, --config <FILE> Sets a custom config file
|
|
|
|
SUBCOMMANDS:
|
|
help Prints this message or the help of the given subcommand(s)
|
|
test does testing things";
|
|
|
|
#[test]
|
|
fn with_template() {
|
|
let app = app_example1().template(EXAMPLE1_TMPL_S);
|
|
assert!(test::compare_output(
|
|
app,
|
|
"MyApp --help",
|
|
SIMPLE_TEMPLATE,
|
|
false
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn custom_template() {
|
|
let app = app_example1().template(EXAMPLE1_TMPS_F);
|
|
assert!(test::compare_output(
|
|
app,
|
|
"MyApp --help",
|
|
CUSTOM_TEMPL_HELP,
|
|
false
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn template_empty() {
|
|
let app = App::new("MyApp")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.about("Does awesome things")
|
|
.template("");
|
|
assert!(test::compare_output(app, "MyApp --help", "", false));
|
|
}
|
|
|
|
#[test]
|
|
fn template_notag() {
|
|
let app = App::new("MyApp")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.about("Does awesome things")
|
|
.template("test no tag test");
|
|
assert!(test::compare_output(
|
|
app,
|
|
"MyApp --help",
|
|
"test no tag test",
|
|
false
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn template_unknowntag() {
|
|
let app = App::new("MyApp")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.about("Does awesome things")
|
|
.template("test {unknown_tag} test");
|
|
assert!(test::compare_output(
|
|
app,
|
|
"MyApp --help",
|
|
"test {unknown_tag} test",
|
|
false
|
|
));
|
|
}
|
|
|
|
#[test]
|
|
fn template_author_version() {
|
|
let app = App::new("MyApp")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.about("Does awesome things")
|
|
.template("{author}\n{version}\n{about}\n{bin}");
|
|
assert!(test::compare_output(
|
|
app,
|
|
"MyApp --help",
|
|
"Kevin K. <kbknapp@gmail.com>\n1.0\nDoes awesome things\nMyApp",
|
|
false
|
|
));
|
|
}
|
|
|
|
// ----------
|
|
|
|
fn app_example1<'b, 'c>() -> App<'b, 'c> {
|
|
App::new("MyApp")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.about("Does awesome things")
|
|
.args_from_usage(
|
|
"-c, --config=[FILE] 'Sets a custom config file'
|
|
<output> 'Sets an optional output file'
|
|
-d... 'Turn debugging information on'",
|
|
)
|
|
.subcommand(
|
|
SubCommand::with_name("test")
|
|
.about("does testing things")
|
|
.arg_from_usage("-l, --list 'lists test values'"),
|
|
)
|
|
}
|