mirror of
https://github.com/clap-rs/clap
synced 2024-11-13 16:17:09 +00:00
61c9e6265b
For those that want the original behavior, you can usxe `arg.help_heading(Some("FLAGS"))` on your flags. Limitations: - This will not give you a special sort order - This will not get a `[FLAGS]` added to usage For templates, we removed `{unified}` and `{flags}`. To help people catch these, a debug_assert was added. I'm unsure but I think there might be a change in behavior in calcuating when to show `[OPTION]` in usage. The old code only looked at `required` while flags looked only at arg groups. We now look at both. Ideally we'd add these in `_build` and remove special casing for no-groups except in the sort order of groups. I feel like thats best left for later. This also reduced the scope of `App`s public API. `get_*_with_no_heading` seemed a bit specialized to be in the public API. #2853 looks at splitting it out into its own PR. BREAKING CHANGE: Multiple - `UnifiedHelpMessage` removed - `{flags}` and `{unified}` are removed and will assert when present. - `get_*_with_no_heading` removed Fixes #2807
217 lines
6.3 KiB
Rust
217 lines
6.3 KiB
Rust
use clap::App;
|
|
use clap::{Arg, ArgSettings};
|
|
use criterion::{criterion_group, criterion_main, Criterion};
|
|
use std::io::Cursor;
|
|
|
|
fn build_help(app: &mut App) -> String {
|
|
let mut buf = Cursor::new(Vec::with_capacity(50));
|
|
app.write_help(&mut buf).unwrap();
|
|
let content = buf.into_inner();
|
|
String::from_utf8(content).unwrap()
|
|
}
|
|
|
|
fn app_example1<'c>() -> App<'c> {
|
|
App::new("MyApp")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.about("Does awesome things")
|
|
.arg("-c, --config=[FILE] 'Sets a custom config file'")
|
|
.arg("<output> 'Sets an optional output file'")
|
|
.arg("-d... 'Turn debugging information on'")
|
|
.subcommand(
|
|
App::new("test")
|
|
.about("does testing things")
|
|
.arg("-l, --list 'lists test values'"),
|
|
)
|
|
}
|
|
|
|
fn app_example2<'c>() -> App<'c> {
|
|
App::new("MyApp")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.about("Does awesome things")
|
|
}
|
|
|
|
fn app_example3<'c>() -> App<'c> {
|
|
App::new("MyApp")
|
|
.arg(
|
|
Arg::new("debug")
|
|
.about("turn on debugging information")
|
|
.short('d'),
|
|
)
|
|
.args(&[
|
|
Arg::new("config")
|
|
.about("sets the config file to use")
|
|
.setting(ArgSettings::TakesValue)
|
|
.short('c')
|
|
.long("config"),
|
|
Arg::new("input")
|
|
.about("the input file to use")
|
|
.index(1)
|
|
.setting(ArgSettings::Required),
|
|
])
|
|
.arg("--license 'display the license file'")
|
|
.arg("[output] 'Supply an output file to use'")
|
|
.arg("-i, --int=[IFACE] 'Set an interface to use'")
|
|
}
|
|
|
|
fn app_example4<'c>() -> App<'c> {
|
|
App::new("MyApp")
|
|
.about("Parses an input file to do awesome things")
|
|
.version("1.0")
|
|
.author("Kevin K. <kbknapp@gmail.com>")
|
|
.arg(
|
|
Arg::new("debug")
|
|
.about("turn on debugging information")
|
|
.short('d')
|
|
.long("debug"),
|
|
)
|
|
.arg(
|
|
Arg::new("config")
|
|
.about("sets the config file to use")
|
|
.short('c')
|
|
.long("config"),
|
|
)
|
|
.arg(
|
|
Arg::new("input")
|
|
.about("the input file to use")
|
|
.index(1)
|
|
.setting(ArgSettings::Required),
|
|
)
|
|
}
|
|
|
|
fn app_example5<'c>() -> App<'c> {
|
|
App::new("MyApp").arg(
|
|
Arg::new("awesome")
|
|
.about("turns up the awesome")
|
|
.short('a')
|
|
.long("awesome")
|
|
.setting(ArgSettings::MultipleOccurrences)
|
|
.requires("config")
|
|
.conflicts_with("output"),
|
|
)
|
|
}
|
|
|
|
fn app_example6<'c>() -> App<'c> {
|
|
App::new("MyApp")
|
|
.arg(
|
|
Arg::new("input")
|
|
.about("the input file to use")
|
|
.index(1)
|
|
.requires("config")
|
|
.conflicts_with("output")
|
|
.setting(ArgSettings::Required),
|
|
)
|
|
.arg(Arg::new("config").about("the config file to use").index(2))
|
|
}
|
|
|
|
fn app_example7<'c>() -> App<'c> {
|
|
App::new("MyApp")
|
|
.arg(Arg::new("config"))
|
|
.arg(Arg::new("output"))
|
|
.arg(
|
|
Arg::new("input")
|
|
.about("the input file to use")
|
|
.setting(ArgSettings::TakesValue)
|
|
.setting(ArgSettings::MultipleValues)
|
|
.setting(ArgSettings::MultipleOccurrences)
|
|
.setting(ArgSettings::Required)
|
|
.short('i')
|
|
.long("input")
|
|
.requires("config")
|
|
.conflicts_with("output"),
|
|
)
|
|
}
|
|
|
|
fn app_example8<'c>() -> App<'c> {
|
|
App::new("MyApp")
|
|
.arg(Arg::new("config"))
|
|
.arg(Arg::new("output"))
|
|
.arg(
|
|
Arg::new("input")
|
|
.about("the input file to use")
|
|
.setting(ArgSettings::TakesValue)
|
|
.setting(ArgSettings::MultipleValues)
|
|
.setting(ArgSettings::MultipleOccurrences)
|
|
.setting(ArgSettings::Required)
|
|
.short('i')
|
|
.long("input")
|
|
.requires("config")
|
|
.conflicts_with("output"),
|
|
)
|
|
}
|
|
|
|
fn app_example10<'c>() -> App<'c> {
|
|
App::new("myapp").about("does awesome things").arg(
|
|
Arg::new("CONFIG")
|
|
.about("The config file to use (default is \"config.json\")")
|
|
.short('c')
|
|
.setting(ArgSettings::TakesValue),
|
|
)
|
|
}
|
|
|
|
pub fn example1(c: &mut Criterion) {
|
|
let mut app = app_example1();
|
|
c.bench_function("example1", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example2(c: &mut Criterion) {
|
|
let mut app = app_example2();
|
|
c.bench_function("example2", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example3(c: &mut Criterion) {
|
|
let mut app = app_example3();
|
|
c.bench_function("example3", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example4(c: &mut Criterion) {
|
|
let mut app = app_example4();
|
|
c.bench_function("example4", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example5(c: &mut Criterion) {
|
|
let mut app = app_example5();
|
|
c.bench_function("example5", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example6(c: &mut Criterion) {
|
|
let mut app = app_example6();
|
|
c.bench_function("example6", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example7(c: &mut Criterion) {
|
|
let mut app = app_example7();
|
|
c.bench_function("example7", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example8(c: &mut Criterion) {
|
|
let mut app = app_example8();
|
|
c.bench_function("example8", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example10(c: &mut Criterion) {
|
|
let mut app = app_example10();
|
|
c.bench_function("example10", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
pub fn example4_template(c: &mut Criterion) {
|
|
let mut app = app_example4().help_template("{bin} {version}\n{author}\n{about}\n\nUSAGE:\n {usage}\n\nOPTIONS:\n{options}\n\nARGS:\n{args}\n");
|
|
c.bench_function("example4_template", |b| b.iter(|| build_help(&mut app)));
|
|
}
|
|
|
|
criterion_group!(
|
|
benches,
|
|
example1,
|
|
example2,
|
|
example3,
|
|
example4,
|
|
example5,
|
|
example6,
|
|
example7,
|
|
example8,
|
|
example10,
|
|
example4_template
|
|
);
|
|
|
|
criterion_main!(benches);
|