Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-13 14:22:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

chore(complete): Add descriptions to dynamic Zsh completions

Browse source
This commit is contained in:
Vivien Maisonneuve 2024-10-13 21:04:52 +02:00
parent 61f5ee514f
commit 81d92682ce
3 changed files with 48 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
clap_complete/src/env/shells.rs vendored
View file

@ -361,7 +361,7 @@ function _clap_dynamic_completer_NAME() {
)}")
if [[ -n $completions ]]; then
compadd -a completions
_describe 'values' completions
fi
}
@ -398,8 +398,31 @@ compdef _clap_dynamic_completer_NAME BIN"#
if i != 0 {
write!(buf, "{}", ifs.as_deref().unwrap_or("\n"))?;
}
write!(buf, "{}", candidate.get_value().to_string_lossy())?;
write!(
buf,
"{}",
Self::escape_value(&candidate.get_value().to_string_lossy())
)?;
if let Some(help) = candidate.get_help() {
write!(
buf,
":{}",
Self::escape_help(help.to_string().lines().next().unwrap_or_default())
)?;
}
}
Ok(())
}
}
impl Zsh {
/// Escape value string
fn escape_value(string: &str) -> String {
string.replace('\\', "\\\\").replace(':', "\\:")
}
/// Escape help string
fn escape_help(string: &str) -> String {
string.replace('\\', "\\\\")
}
}

2
clap_complete/tests/snapshots/home/dynamic-env/exhaustive/zsh/zsh/_exhaustive
View file

@ -11,7 +11,7 @@ function _clap_dynamic_completer_exhaustive() {
)}")
if [[ -n $completions ]]; then
compadd -a completions
_describe 'values' completions
fi
}

28
clap_complete/tests/testsuite/zsh.rs
View file

@ -192,8 +192,12 @@ fn complete_dynamic_env_toplevel() {
let input = "exhaustive \t\t";
let expected = snapbox::str![[r#"
% exhaustive
--generate --help action help last quote
--global --version alias hint pacman value
--generate -- generate
--global -- everywhere
--help -- Print help
--version -- Print version
help -- Print this message or the help of the given subcommand(s)
action alias hint last pacman quote value
"#]];
let actual = runtime.complete(input, &term).unwrap();
assert_data_eq!(actual, expected);
@ -213,9 +217,18 @@ fn complete_dynamic_env_quoted_help() {
let input = "exhaustive quote \t\t";
let expected = snapbox::str![[r#"
% exhaustive quote
--backslash --choice --global --version cmd-brackets cmd-single-quotes
--backticks --double-quotes --help cmd-backslash cmd-double-quotes escape-help
--brackets --expansions --single-quotes cmd-backticks cmd-expansions help
--global -- everywhere
--help -- Print help (see more with '--help')
--version -- Print version
cmd-backslash --backslash -- Avoid '/n'
cmd-backticks --backticks -- For more information see `echo test`
cmd-brackets --brackets -- List packages [filter]
cmd-double-quotes --double-quotes -- Can be "always", "auto", or "never"
cmd-expansions --expansions -- Execute the shell command with $SHELL
cmd-single-quotes --single-quotes -- Can be 'always', 'auto', or 'never'
escape-help -- /tab/t"'
help -- Print this message or the help of the given subcommand(s)
--choice
"#]];
let actual = runtime.complete(input, &term).unwrap();
assert_data_eq!(actual, expected);
@ -260,7 +273,10 @@ fn complete_dynamic_env_quoted_value() {
let input = "exhaustive quote --choice \t\t";
let expected = snapbox::str![[r#"
% exhaustive quote --choice
another/ shell bash fish zsh
another shell -- something with a space
bash -- bash (shell)
fish -- fish shell
zsh -- zsh shell
"#]];
let actual = runtime.complete(input, &term).unwrap();
assert_data_eq!(actual, expected);