Skip to content

Commit

Permalink
feat(complete): Show help in dynamic completions
Browse files Browse the repository at this point in the history
  • Loading branch information
@ModProg
ModProg committed Aug 1, 2023
1 parent bacc5ce commit 71ce87c
Show file tree
Hide file tree
Showing 12 changed files with 147 additions and 90 deletions.
1 change: 1 addition & 0 deletions clap_complete/examples/exhaustive.rs
View file
Expand Up @@ -186,6 +186,7 @@ fn cli() -> clap::Command {
.long("email")
.value_hint(clap::ValueHint::EmailAddress),
]),
clap::Command::new("escape-help").about("\\tab\t\"'"),
]);
#[cfg(feature = "unstable-dynamic")]
let cli = clap_complete::dynamic::shells::CompleteCommand::augment_subcommands(cli);
Expand Down
94 changes: 32 additions & 62 deletions clap_complete/src/dynamic/completer.rs
View file
@@ -1,58 +1,35 @@
use std::ffi::OsStr;
use std::ffi::OsString;

use clap::builder::StyledStr;
use clap_lex::OsStrExt as _;

/// Gets all the long options, their visible aliases and flags of a [`clap::Command`].
/// Includes `help` and `version` depending on the [`clap::Command`] settings.
pub fn longs_and_visible_aliases(p: &clap::Command) -> Vec<String> {
pub fn longs_and_visible_aliases(p: &clap::Command) -> Vec<(String, Option<StyledStr>)> {
debug!("longs: name={}", p.get_name());

p.get_arguments()
.filter_map(|a| {
if !a.is_positional() {
if a.get_visible_aliases().is_some() && a.get_long().is_some() {
let mut visible_aliases: Vec<_> = a
.get_visible_aliases()
.unwrap()
.into_iter()
.map(|s| s.to_string())
.collect();
visible_aliases.push(a.get_long().unwrap().to_string());
Some(visible_aliases)
} else if a.get_visible_aliases().is_none() && a.get_long().is_some() {
Some(vec![a.get_long().unwrap().to_string()])
} else {
None
}
} else {
None
}
a.get_long_and_visible_aliases().map(|longs| {
longs
.into_iter()
.map(|s| (s.to_string(), a.get_help().cloned()))
})
})
.flatten()
.collect()
}

/// Gets all the short options, their visible aliases and flags of a [`clap::Command`].
/// Includes `h` and `V` depending on the [`clap::Command`] settings.
pub fn shorts_and_visible_aliases(p: &clap::Command) -> Vec<char> {
pub fn shorts_and_visible_aliases(p: &clap::Command) -> Vec<(char, Option<StyledStr>)> {
debug!("shorts: name={}", p.get_name());

p.get_arguments()
.filter_map(|a| {
if !a.is_positional() {
if a.get_visible_short_aliases().is_some() && a.get_short().is_some() {
let mut shorts_and_visible_aliases = a.get_visible_short_aliases().unwrap();
shorts_and_visible_aliases.push(a.get_short().unwrap());
Some(shorts_and_visible_aliases)
} else if a.get_visible_short_aliases().is_none() && a.get_short().is_some() {
Some(vec![a.get_short().unwrap()])
} else {
None
}
} else {
None
}
a.get_short_and_visible_aliases()
.map(|shorts| shorts.into_iter().map(|s| (s, a.get_help().cloned())))
})
.flatten()
.collect()
Expand All @@ -73,19 +50,13 @@ pub fn possible_values(a: &clap::Arg) -> Option<Vec<clap::builder::PossibleValue
///
/// Subcommand `rustup toolchain install` would be converted to
/// `("install", "rustup toolchain install")`.
pub fn subcommands(p: &clap::Command) -> Vec<String> {
pub fn subcommands(p: &clap::Command) -> Vec<(String, Option<StyledStr>)> {
debug!("subcommands: name={}", p.get_name());
debug!("subcommands: Has subcommands...{:?}", p.has_subcommands());

let mut subcmds = vec![];

for sc in p.get_subcommands() {
debug!("subcommands:iter: name={}", sc.get_name(),);

subcmds.push(sc.get_name().to_string());
}

subcmds
p.get_subcommands()
.map(|sc| (sc.get_name().to_string(), sc.get_about().cloned()))
.collect()
}

/// Shell-specific completions
Expand Down Expand Up @@ -116,7 +87,7 @@ pub fn complete(
args: Vec<std::ffi::OsString>,
arg_index: usize,
current_dir: Option<&std::path::Path>,
) -> Result<Vec<std::ffi::OsString>, std::io::Error> {
) -> Result<Vec<(std::ffi::OsString, Option<StyledStr>)>, std::io::Error> {
cmd.build();

let raw_args = clap_lex::RawArgs::new(args.into_iter());
Expand Down Expand Up @@ -175,7 +146,7 @@ fn complete_arg(
current_dir: Option<&std::path::Path>,
pos_index: usize,
is_escaped: bool,
) -> Result<Vec<std::ffi::OsString>, std::io::Error> {
) -> Result<Vec<(std::ffi::OsString, Option<StyledStr>)>, std::io::Error> {
debug!(
"complete_arg: arg={:?}, cmd={:?}, current_dir={:?}, pos_index={}, is_escaped={}",
arg,
Expand All @@ -194,26 +165,24 @@ fn complete_arg(
completions.extend(
complete_arg_value(value.to_str().ok_or(value), arg, current_dir)
.into_iter()
.map(|os| {
.map(|(os, help)| {
// HACK: Need better `OsStr` manipulation
format!("--{}={}", flag, os.to_string_lossy()).into()
(format!("--{}={}", flag, os.to_string_lossy()).into(), help)
}),
)
}
} else {
completions.extend(
longs_and_visible_aliases(cmd)
.into_iter()
.filter_map(|f| f.starts_with(flag).then(|| format!("--{f}").into())),
);
completions.extend(longs_and_visible_aliases(cmd).into_iter().filter_map(
|(f, help)| f.starts_with(flag).then(|| (format!("--{f}").into(), help)),
));
}
}
} else if arg.is_escape() || arg.is_stdio() || arg.is_empty() {
// HACK: Assuming knowledge of is_escape / is_stdio
completions.extend(
longs_and_visible_aliases(cmd)
.into_iter()
.map(|f| format!("--{f}").into()),
.map(|(f, help)| (format!("--{f}").into(), help)),
);
}

Expand All @@ -228,7 +197,7 @@ fn complete_arg(
shorts_and_visible_aliases(cmd)
.into_iter()
// HACK: Need better `OsStr` manipulation
.map(|f| format!("{}{}", dash_or_arg, f).into()),
.map(|(f, help)| (format!("{}{}", dash_or_arg, f).into(), help)),
);
}
}
Expand All @@ -251,15 +220,16 @@ fn complete_arg_value(
value: Result<&str, &OsStr>,
arg: &clap::Arg,
current_dir: Option<&std::path::Path>,
) -> Vec<OsString> {
) -> Vec<(OsString, Option<StyledStr>)> {
let mut values = Vec::new();
debug!("complete_arg_value: arg={arg:?}, value={value:?}");

if let Some(possible_values) = possible_values(arg) {
if let Ok(value) = value {
values.extend(possible_values.into_iter().filter_map(|p| {
let name = p.get_name();
name.starts_with(value).then(|| name.into())
name.starts_with(value)
.then(|| (name.into(), p.get_help().cloned()))
}));
}
} else {
Expand Down Expand Up @@ -308,7 +278,7 @@ fn complete_path(
value_os: &OsStr,
current_dir: Option<&std::path::Path>,
is_wanted: impl Fn(&std::path::Path) -> bool,
) -> Vec<OsString> {
) -> Vec<(OsString, Option<StyledStr>)> {
let mut completions = Vec::new();

let current_dir = match current_dir {
Expand Down Expand Up @@ -340,20 +310,20 @@ fn complete_path(
let path = entry.path();
let mut suggestion = pathdiff::diff_paths(&path, current_dir).unwrap_or(path);
suggestion.push(""); // Ensure trailing `/`
completions.push(suggestion.as_os_str().to_owned());
completions.push((suggestion.as_os_str().to_owned(), None));
} else {
let path = entry.path();
if is_wanted(&path) {
let suggestion = pathdiff::diff_paths(&path, current_dir).unwrap_or(path);
completions.push(suggestion.as_os_str().to_owned());
completions.push((suggestion.as_os_str().to_owned(), None));
}
}
}

completions
}

fn complete_subcommand(value: &str, cmd: &clap::Command) -> Vec<OsString> {
fn complete_subcommand(value: &str, cmd: &clap::Command) -> Vec<(OsString, Option<StyledStr>)> {
debug!(
"complete_subcommand: cmd={:?}, value={:?}",
cmd.get_name(),
Expand All @@ -362,8 +332,8 @@ fn complete_subcommand(value: &str, cmd: &clap::Command) -> Vec<OsString> {

let mut scs = subcommands(cmd)
.into_iter()
.filter(|x| x.starts_with(value))
.map(OsString::from)
.filter(|x| x.0.starts_with(value))
.map(|x| (OsString::from(&x.0), x.1))
.collect::<Vec<_>>();
scs.sort();
scs.dedup();
Expand Down
2 changes: 1 addition & 1 deletion clap_complete/src/dynamic/shells/bash.rs
View file
Expand Up @@ -73,7 +73,7 @@ complete -o nospace -o bashdefault -F _clap_complete_NAME BIN
let ifs: Option<String> = std::env::var("IFS").ok().and_then(|i| i.parse().ok());
let completions = crate::dynamic::complete(cmd, args, index, current_dir)?;

for (i, completion) in completions.iter().enumerate() {
for (i, (completion, _)) in completions.iter().enumerate() {
if i != 0 {
write!(buf, "{}", ifs.as_deref().unwrap_or("\n"))?;
}
Expand Down
8 changes: 6 additions & 2 deletions clap_complete/src/dynamic/shells/fish.rs
View file
Expand Up @@ -30,8 +30,12 @@ impl crate::dynamic::Completer for Fish {
let index = args.len() - 1;
let completions = crate::dynamic::complete(cmd, args, index, current_dir)?;

for completion in completions {
writeln!(buf, "{}", completion.to_string_lossy())?;
for (completion, help) in completions {
write!(buf, "{}", completion.to_string_lossy())?;
if let Some(help) = help {
write!(buf, "\t{help}")?;
}
writeln!(buf)?;
}
Ok(())
}
Expand Down
38 changes: 36 additions & 2 deletions clap_complete/tests/snapshots/home/static/exhaustive/bash/.bashrc
View file
Expand Up @@ -23,6 +23,9 @@ _exhaustive() {
exhaustive,complete)
cmd="exhaustive__complete"
;;
exhaustive,escape-help)
cmd="exhaustive__escape__help"
;;
exhaustive,help)
cmd="exhaustive__help"
;;
Expand Down Expand Up @@ -50,6 +53,9 @@ _exhaustive() {
exhaustive__help,complete)
cmd="exhaustive__help__complete"
;;
exhaustive__help,escape-help)
cmd="exhaustive__help__escape__help"
;;
exhaustive__help,help)
cmd="exhaustive__help__help"
;;
Expand Down Expand Up @@ -159,7 +165,7 @@ _exhaustive() {

case "${cmd}" in
exhaustive)
opts="-h -V --global --generate --help --version action quote value pacman last alias hint complete help"
opts="-h -V --global --generate --help --version action quote value pacman last alias hint escape-help complete help"
if [[ ${cur} == -* || ${COMP_CWORD} -eq 1 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
Expand Down Expand Up @@ -250,8 +256,22 @@ _exhaustive() {
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
exhaustive__escape__help)
opts="-h -V --global --help --version"
if [[ ${cur} == -* || ${COMP_CWORD} -eq 2 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
fi
case "${prev}" in
*)
COMPREPLY=()
;;
esac
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
exhaustive__help)
opts="action quote value pacman last alias hint complete help"
opts="action quote value pacman last alias hint escape-help complete help"
if [[ ${cur} == -* || ${COMP_CWORD} -eq 2 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
Expand Down Expand Up @@ -306,6 +326,20 @@ _exhaustive() {
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
exhaustive__help__escape__help)
opts=""
if [[ ${cur} == -* || ${COMP_CWORD} -eq 3 ]] ; then
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
fi
case "${prev}" in
*)
COMPREPLY=()
;;
esac
COMPREPLY=( $(compgen -W "${opts}" -- "${cur}") )
return 0
;;
exhaustive__help__help)
opts=""
if [[ ${cur} == -* || ${COMP_CWORD} -eq 3 ]] ; then
Expand Down
11 changes: 11 additions & 0 deletions clap_complete/tests/snapshots/home/static/exhaustive/elvish/elvish/rc.elv
View file
Expand Up @@ -33,6 +33,7 @@ set edit:completion:arg-completer[exhaustive] = {|@words|
cand last 'last'
cand alias 'alias'
cand hint 'hint'
cand escape-help '\tab "'''
cand complete 'Register shell completions for this program'
cand help 'Print this message or the help of the given subcommand(s)'
}
Expand Down Expand Up @@ -226,6 +227,13 @@ set edit:completion:arg-completer[exhaustive] = {|@words|
cand -V 'Print version'
cand --version 'Print version'
}
&'exhaustive;escape-help'= {
cand --global 'everywhere'
cand -h 'Print help'
cand --help 'Print help'
cand -V 'Print version'
cand --version 'Print version'
}
&'exhaustive;complete'= {
cand --shell 'Specify shell to complete for'
cand --register 'Path to write completion-registration to'
Expand All @@ -243,6 +251,7 @@ set edit:completion:arg-completer[exhaustive] = {|@words|
cand last 'last'
cand alias 'alias'
cand hint 'hint'
cand escape-help '\tab "'''
cand complete 'Register shell completions for this program'
cand help 'Print this message or the help of the given subcommand(s)'
}
Expand Down Expand Up @@ -284,6 +293,8 @@ set edit:completion:arg-completer[exhaustive] = {|@words|
}
&'exhaustive;help;hint'= {
}
&'exhaustive;help;escape-help'= {
}
&'exhaustive;help;complete'= {
}
&'exhaustive;help;help'= {
Expand Down

0 comments on commit 71ce87c

Please sign in to comment.