use crate::complete::CompleteOptions;
use heck::ToSnakeCase;
pub fn complete_zsh(opts: &CompleteOptions) -> String {
let usage_bin = &opts.usage_bin;
let bin = &opts.bin;
let bin_snake = bin.to_snake_case();
let spec_variable = if let Some(cache_key) = &opts.cache_key {
format!("_usage_spec_{bin_snake}_{}", cache_key.to_snake_case())
} else {
format!("_usage_spec_{bin_snake}")
};
let generated_comment = if let Some(source_file) = &opts.source_file {
format!("# @generated by usage-cli from {source_file}")
} else {
"# @generated by usage-cli from usage spec".to_string()
};
let mut out = vec![format!(
r#"#compdef {bin}
{generated_comment}
local curcontext="$curcontext""#
)];
if let Some(_usage_cmd) = &opts.usage_cmd {
out.push(format!(
r#"
# caching config
_usage_{bin_snake}_cache_policy() {{
if [[ -z "${{lifetime}}" ]]; then
lifetime=$((60*60*4)) # 4 hours
fi
local -a oldp
oldp=( "$1"(Nms+${{lifetime}}) )
(( $#oldp ))
}}"#
));
}
out.push(format!(
r#"
_{bin_snake}() {{
typeset -A opt_args
local curcontext="$curcontext" cache_policy
if ! type -p {usage_bin} &> /dev/null; then
echo >&2
echo "Error: {usage_bin} CLI not found. This is required for completions to work in {bin}." >&2
echo "See https://usage.jdx.dev for more information." >&2
return 1
fi"#,
));
let file_write_logic = if let Some(usage_cmd) = &opts.usage_cmd {
if opts.cache_key.is_some() {
format!(
r#"if [[ ! -f "$spec_file" ]]; then
{usage_cmd} >| "$spec_file"
fi"#
)
} else {
format!(r#"{usage_cmd} >| "$spec_file""#)
}
} else if let Some(spec) = &opts.spec {
let heredoc = format!(
r#"cat >| "$spec_file" <<'__USAGE_EOF__'
{spec}
__USAGE_EOF__"#,
spec = spec.to_string().trim()
);
if opts.cache_key.is_some() {
format!(
r#"if [[ ! -f "$spec_file" ]]; then
{heredoc}
fi"#
)
} else {
heredoc.to_string()
}
} else {
String::new()
};
out.push(format!(
r#"
local spec_file="${{TMPDIR:-/tmp}}/usage_{spec_variable}.spec"
{file_write_logic}
local -a completions=()
while IFS= read -r line; do
completions+=("$line")
done < <(command {usage_bin} complete-word --shell zsh -f "$spec_file" -- "${{words[@]}}")
_describe 'completions' completions -S ''
return 0
}}
if [ "$funcstack[1]" = "_{bin_snake}" ]; then
_{bin_snake} "$@"
else
compdef _{bin_snake} {bin}
fi
# vim: noet ci pi sts=0 sw=4 ts=4"#,
));
out.join("\n")
}
#[cfg(test)]
mod tests {
use super::*;
use crate::test::SPEC_KITCHEN_SINK;
use insta::assert_snapshot;
#[test]
fn test_complete_zsh() {
assert_snapshot!(complete_zsh(&CompleteOptions {
usage_bin: "usage".to_string(),
shell: "zsh".to_string(),
bin: "mycli".to_string(),
cache_key: None,
spec: None,
usage_cmd: Some("mycli complete --usage".to_string()),
include_bash_completion_lib: false,
source_file: None,
}));
assert_snapshot!(complete_zsh(&CompleteOptions {
usage_bin: "usage".to_string(),
shell: "zsh".to_string(),
bin: "mycli".to_string(),
cache_key: Some("1.2.3".to_string()),
spec: None,
usage_cmd: Some("mycli complete --usage".to_string()),
include_bash_completion_lib: false,
source_file: None,
}));
assert_snapshot!(complete_zsh(&CompleteOptions {
usage_bin: "usage".to_string(),
shell: "zsh".to_string(),
bin: "mycli".to_string(),
cache_key: None,
spec: Some(SPEC_KITCHEN_SINK.clone()),
usage_cmd: None,
include_bash_completion_lib: false,
source_file: None,
}));
}
}