mirror of
https://github.com/clap-rs/clap
synced 2025-01-05 17:28:42 +00:00
a61b60816c
`App::get_matches` lazily post-processes `App`s and `Arg`s so we don't do it to subcommands that are never run (downside being people have to exercise their full app to get debug_asserts). `clap_generate` was only post-processing the top-level `App` and `Arg`s, ignoring the sub-commands. In #2858, we noticed that `--version` was being left in the completions instead of being removed during the `_build` step. We would also have an incorrect `num_vals` and a host of other problems. This change adds a `App::_build_all` function for `clap_generate` to use to eagerly build everything. By having it there, we make sure everywhere that needs eager building, gets it (like some tests). In `clap_generate::utils`, we add a unit test to ensure the subcommand's `--version` was removed. For some other tests specifying `.version()`, I added `AppSettings::PropagateVersion` to make it behave more consistently. The places I didn't were generally where the version was conditionally set. For `clap_generate/tests/generate_completions.rs`, I had to adjust the `conflicts_with` because the subcommand was inheriting the argument with it defined *but* the subcommand did not have the argument, tripping up a debug assert. Fixes #2860
201 lines
9.2 KiB
Rust
201 lines
9.2 KiB
Rust
use super::*;
|
|
|
|
fn build_app() -> App<'static> {
|
|
build_app_with_name("myapp")
|
|
}
|
|
|
|
fn build_app_with_name(s: &'static str) -> App<'static> {
|
|
App::new(s)
|
|
.version("3.0")
|
|
.setting(AppSettings::PropagateVersion)
|
|
.about("Tests completions")
|
|
.arg(
|
|
Arg::new("file")
|
|
.value_hint(ValueHint::FilePath)
|
|
.about("some input file"),
|
|
)
|
|
.subcommand(
|
|
App::new("test").about("tests things").arg(
|
|
Arg::new("case")
|
|
.long("case")
|
|
.takes_value(true)
|
|
.about("the case to test"),
|
|
),
|
|
)
|
|
}
|
|
|
|
#[test]
|
|
fn fish() {
|
|
let mut app = build_app();
|
|
common(Fish, &mut app, "myapp", FISH);
|
|
}
|
|
|
|
static FISH: &str = r#"complete -c myapp -n "__fish_use_subcommand" -s h -l help -d 'Print help information'
|
|
complete -c myapp -n "__fish_use_subcommand" -s V -l version -d 'Print version information'
|
|
complete -c myapp -n "__fish_use_subcommand" -f -a "test" -d 'tests things'
|
|
complete -c myapp -n "__fish_use_subcommand" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
|
|
complete -c myapp -n "__fish_seen_subcommand_from test" -l case -d 'the case to test' -r
|
|
complete -c myapp -n "__fish_seen_subcommand_from test" -s h -l help -d 'Print help information'
|
|
complete -c myapp -n "__fish_seen_subcommand_from test" -s V -l version -d 'Print version information'
|
|
complete -c myapp -n "__fish_seen_subcommand_from help" -s h -l help -d 'Print help information'
|
|
"#;
|
|
|
|
#[test]
|
|
fn fish_with_special_commands() {
|
|
let mut app = build_app_special_commands();
|
|
common(Fish, &mut app, "my_app", FISH_SPECIAL_CMDS);
|
|
}
|
|
|
|
fn build_app_special_commands() -> App<'static> {
|
|
build_app_with_name("my_app")
|
|
.subcommand(
|
|
App::new("some_cmd").about("tests other things").arg(
|
|
Arg::new("config")
|
|
.long("--config")
|
|
.takes_value(true)
|
|
.about("the other case to test"),
|
|
),
|
|
)
|
|
.subcommand(App::new("some-cmd-with-hypens").alias("hyphen"))
|
|
}
|
|
|
|
static FISH_SPECIAL_CMDS: &str = r#"complete -c my_app -n "__fish_use_subcommand" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_use_subcommand" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_use_subcommand" -f -a "test" -d 'tests things'
|
|
complete -c my_app -n "__fish_use_subcommand" -f -a "some_cmd" -d 'tests other things'
|
|
complete -c my_app -n "__fish_use_subcommand" -f -a "some-cmd-with-hypens"
|
|
complete -c my_app -n "__fish_use_subcommand" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
|
|
complete -c my_app -n "__fish_seen_subcommand_from test" -l case -d 'the case to test' -r
|
|
complete -c my_app -n "__fish_seen_subcommand_from test" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from test" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd" -l config -d 'the other case to test' -r
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some-cmd-with-hypens" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some-cmd-with-hypens" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from help" -s h -l help -d 'Print help information'
|
|
"#;
|
|
|
|
#[test]
|
|
fn fish_with_special_help() {
|
|
let mut app = build_app_special_help();
|
|
common(Fish, &mut app, "my_app", FISH_SPECIAL_HELP);
|
|
}
|
|
|
|
fn build_app_special_help() -> App<'static> {
|
|
App::new("my_app")
|
|
.version("3.0")
|
|
.arg(
|
|
Arg::new("single-quotes")
|
|
.long("single-quotes")
|
|
.about("Can be 'always', 'auto', or 'never'"),
|
|
)
|
|
.arg(
|
|
Arg::new("double-quotes")
|
|
.long("double-quotes")
|
|
.about("Can be \"always\", \"auto\", or \"never\""),
|
|
)
|
|
.arg(
|
|
Arg::new("backticks")
|
|
.long("backticks")
|
|
.about("For more information see `echo test`"),
|
|
)
|
|
.arg(Arg::new("backslash").long("backslash").about("Avoid '\\n'"))
|
|
.arg(
|
|
Arg::new("brackets")
|
|
.long("brackets")
|
|
.about("List packages [filter]"),
|
|
)
|
|
.arg(
|
|
Arg::new("expansions")
|
|
.long("expansions")
|
|
.about("Execute the shell command with $SHELL"),
|
|
)
|
|
}
|
|
|
|
static FISH_SPECIAL_HELP: &str = r#"complete -c my_app -s h -l help -d 'Print help information'
|
|
complete -c my_app -s V -l version -d 'Print version information'
|
|
complete -c my_app -l single-quotes -d 'Can be \'always\', \'auto\', or \'never\''
|
|
complete -c my_app -l double-quotes -d 'Can be "always", "auto", or "never"'
|
|
complete -c my_app -l backticks -d 'For more information see `echo test`'
|
|
complete -c my_app -l backslash -d 'Avoid \'\\n\''
|
|
complete -c my_app -l brackets -d 'List packages [filter]'
|
|
complete -c my_app -l expansions -d 'Execute the shell command with $SHELL'
|
|
"#;
|
|
|
|
#[test]
|
|
fn fish_with_aliases() {
|
|
let mut app = build_app_with_aliases();
|
|
common(Fish, &mut app, "cmd", FISH_ALIASES);
|
|
}
|
|
|
|
fn build_app_with_aliases() -> App<'static> {
|
|
App::new("cmd")
|
|
.version("3.0")
|
|
.about("testing bash completions")
|
|
.arg(
|
|
Arg::new("flag")
|
|
.short('f')
|
|
.visible_short_alias('F')
|
|
.long("flag")
|
|
.visible_alias("flg")
|
|
.about("cmd flag"),
|
|
)
|
|
.arg(
|
|
Arg::new("option")
|
|
.short('o')
|
|
.visible_short_alias('O')
|
|
.long("option")
|
|
.visible_alias("opt")
|
|
.about("cmd option")
|
|
.takes_value(true),
|
|
)
|
|
.arg(Arg::new("positional"))
|
|
}
|
|
|
|
static FISH_ALIASES: &str = r#"complete -c cmd -s o -s O -l option -l opt -d 'cmd option' -r
|
|
complete -c cmd -s h -l help -d 'Print help information'
|
|
complete -c cmd -s V -l version -d 'Print version information'
|
|
complete -c cmd -s f -s F -l flag -l flg -d 'cmd flag'
|
|
"#;
|
|
|
|
#[test]
|
|
fn fish_with_sub_subcommands() {
|
|
let mut app = build_app_sub_subcommands();
|
|
common(Fish, &mut app, "my_app", FISH_SUB_SUBCMDS);
|
|
}
|
|
|
|
fn build_app_sub_subcommands() -> App<'static> {
|
|
build_app_with_name("my_app").subcommand(
|
|
App::new("some_cmd")
|
|
.about("top level subcommand")
|
|
.subcommand(
|
|
App::new("sub_cmd").about("sub-subcommand").arg(
|
|
Arg::new("config")
|
|
.long("--config")
|
|
.takes_value(true)
|
|
.about("the other case to test"),
|
|
),
|
|
),
|
|
)
|
|
}
|
|
|
|
static FISH_SUB_SUBCMDS: &str = r#"complete -c my_app -n "__fish_use_subcommand" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_use_subcommand" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_use_subcommand" -f -a "test" -d 'tests things'
|
|
complete -c my_app -n "__fish_use_subcommand" -f -a "some_cmd" -d 'top level subcommand'
|
|
complete -c my_app -n "__fish_use_subcommand" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
|
|
complete -c my_app -n "__fish_seen_subcommand_from test" -l case -d 'the case to test' -r
|
|
complete -c my_app -n "__fish_seen_subcommand_from test" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from test" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and not __fish_seen_subcommand_from sub_cmd; and not __fish_seen_subcommand_from help" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and not __fish_seen_subcommand_from sub_cmd; and not __fish_seen_subcommand_from help" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and not __fish_seen_subcommand_from sub_cmd; and not __fish_seen_subcommand_from help" -f -a "sub_cmd" -d 'sub-subcommand'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and not __fish_seen_subcommand_from sub_cmd; and not __fish_seen_subcommand_from help" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and __fish_seen_subcommand_from sub_cmd" -l config -d 'the other case to test' -r
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and __fish_seen_subcommand_from sub_cmd" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and __fish_seen_subcommand_from sub_cmd" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and __fish_seen_subcommand_from help" -s h -l help -d 'Print help information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from some_cmd; and __fish_seen_subcommand_from help" -s V -l version -d 'Print version information'
|
|
complete -c my_app -n "__fish_seen_subcommand_from help" -s h -l help -d 'Print help information'
|
|
"#;
|