mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 06:42:33 +00:00
Merge pull request #5706 from shannmu/external_subcommand
feat: Simple support to complete external subcommand
This commit is contained in:
commit
fca8f73c2c
4 changed files with 101 additions and 3 deletions
|
@ -7,6 +7,7 @@ use super::custom::complete_path;
|
|||
use super::ArgValueCandidates;
|
||||
use super::ArgValueCompleter;
|
||||
use super::CompletionCandidate;
|
||||
use super::SubcommandCandidates;
|
||||
|
||||
/// Complete the given command, shell-agnostic
|
||||
pub fn complete(
|
||||
|
@ -414,10 +415,35 @@ fn complete_subcommand(value: &str, cmd: &clap::Command) -> Vec<CompletionCandid
|
|||
value
|
||||
);
|
||||
|
||||
subcommands(cmd)
|
||||
let mut scs: Vec<CompletionCandidate> = subcommands(cmd)
|
||||
.into_iter()
|
||||
.filter(|x| x.get_value().starts_with(value))
|
||||
.collect()
|
||||
.collect();
|
||||
if cmd.is_allow_external_subcommands_set() {
|
||||
let external_completer = cmd.get::<SubcommandCandidates>();
|
||||
if let Some(completer) = external_completer {
|
||||
scs.extend(complete_external_subcommand(value, completer));
|
||||
}
|
||||
}
|
||||
|
||||
scs.sort();
|
||||
scs.dedup();
|
||||
scs
|
||||
}
|
||||
|
||||
fn complete_external_subcommand(
|
||||
value: &str,
|
||||
completer: &SubcommandCandidates,
|
||||
) -> Vec<CompletionCandidate> {
|
||||
debug!("complete_custom_arg_value: completer={completer:?}, value={value:?}");
|
||||
|
||||
let mut values = Vec::new();
|
||||
let custom_arg_values = completer.candidates();
|
||||
values.extend(custom_arg_values);
|
||||
|
||||
values.retain(|comp| comp.get_value().starts_with(value));
|
||||
|
||||
values
|
||||
}
|
||||
|
||||
/// Gets all the long options, their visible aliases and flags of a [`clap::Command`] with formatted `--` prefix.
|
||||
|
|
|
@ -3,6 +3,7 @@ use std::ffi::OsStr;
|
|||
use std::sync::Arc;
|
||||
|
||||
use clap::builder::ArgExt;
|
||||
use clap::builder::CommandExt;
|
||||
use clap_lex::OsStrExt as _;
|
||||
|
||||
use super::CompletionCandidate;
|
||||
|
@ -131,8 +132,54 @@ impl std::fmt::Debug for ArgValueCandidates {
|
|||
|
||||
impl ArgExt for ArgValueCandidates {}
|
||||
|
||||
/// Extend [`Command`][clap::Command] with a [`ValueCandidates`]
|
||||
///
|
||||
/// # Example
|
||||
/// ```rust
|
||||
/// use clap::Parser;
|
||||
/// use clap_complete::engine::{SubcommandCandidates, CompletionCandidate};
|
||||
/// #[derive(Debug, Parser)]
|
||||
/// #[clap(name = "cli", add = SubcommandCandidates::new(|| { vec![
|
||||
/// CompletionCandidate::new("foo"),
|
||||
/// CompletionCandidate::new("bar"),
|
||||
/// CompletionCandidate::new("baz")] }))]
|
||||
/// struct Cli {
|
||||
/// #[arg(long)]
|
||||
/// input: Option<String>,
|
||||
/// }
|
||||
/// ```
|
||||
#[derive(Clone)]
|
||||
pub struct SubcommandCandidates(Arc<dyn ValueCandidates>);
|
||||
|
||||
impl SubcommandCandidates {
|
||||
/// Create a new `SubcommandCandidates` with a custom completer
|
||||
pub fn new<C>(completer: C) -> Self
|
||||
where
|
||||
C: ValueCandidates + 'static,
|
||||
{
|
||||
Self(Arc::new(completer))
|
||||
}
|
||||
|
||||
/// All potential candidates for an external subcommand.
|
||||
///
|
||||
/// See [`CompletionCandidate`] for more information.
|
||||
pub fn candidates(&self) -> Vec<CompletionCandidate> {
|
||||
self.0.candidates()
|
||||
}
|
||||
}
|
||||
|
||||
impl std::fmt::Debug for SubcommandCandidates {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
f.write_str(type_name::<Self>())
|
||||
}
|
||||
}
|
||||
|
||||
impl CommandExt for SubcommandCandidates {}
|
||||
|
||||
/// User-provided completion candidates for an [`Arg`][clap::Arg], see [`ArgValueCandidates`]
|
||||
///
|
||||
/// User-provided completion candidates for an [`Subcommand`][clap::Subcommand], see [`SubcommandCandidates`]
|
||||
///
|
||||
/// This is useful when predefined value hints are not enough.
|
||||
pub trait ValueCandidates: Send + Sync {
|
||||
/// All potential candidates for an argument.
|
||||
|
|
|
@ -11,5 +11,6 @@ pub use complete::complete;
|
|||
pub use custom::ArgValueCandidates;
|
||||
pub use custom::ArgValueCompleter;
|
||||
pub use custom::PathCompleter;
|
||||
pub use custom::SubcommandCandidates;
|
||||
pub use custom::ValueCandidates;
|
||||
pub use custom::ValueCompleter;
|
||||
|
|
|
@ -5,7 +5,7 @@ use std::path::Path;
|
|||
|
||||
use clap::{builder::PossibleValue, Command};
|
||||
use clap_complete::engine::{
|
||||
ArgValueCandidates, ArgValueCompleter, CompletionCandidate, PathCompleter,
|
||||
ArgValueCandidates, ArgValueCompleter, CompletionCandidate, PathCompleter, SubcommandCandidates,
|
||||
};
|
||||
use snapbox::assert_data_eq;
|
||||
|
||||
|
@ -1077,6 +1077,30 @@ pos_b
|
|||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn suggest_external_subcommand() {
|
||||
let mut cmd = Command::new("dynamic")
|
||||
.allow_external_subcommands(true)
|
||||
.add(SubcommandCandidates::new(|| {
|
||||
vec![CompletionCandidate::new("external")]
|
||||
}))
|
||||
.arg(clap::Arg::new("positional").value_parser(["pos1", "pos2", "pos3"]));
|
||||
|
||||
assert_data_eq!(
|
||||
complete!(cmd, " [TAB]"),
|
||||
snapbox::str![
|
||||
"external
|
||||
pos1
|
||||
pos2
|
||||
pos3
|
||||
--help\tPrint help
|
||||
"
|
||||
]
|
||||
);
|
||||
|
||||
assert_data_eq!(complete!(cmd, "e[TAB]"), snapbox::str!["external"]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn sort_and_filter() {
|
||||
let mut cmd = Command::new("exhaustive")
|
||||
|
|
Loading…
Reference in a new issue