//! How to use value hints and generate shell completions. //! //! Usage with zsh: //! ```sh //! cargo run --example value_hints_derive -- --generate=zsh > /usr/local/share/zsh/site-functions/_value_hints_derive //! compinit //! ./target/debug/examples/value_hints_derive -- //! ``` //! fish: //! ```sh //! cargo run --example value_hints_derive -- --generate=fish > value_hints_derive.fish //! . ./value_hints_derive.fish //! ./target/debug/examples/value_hints_derive -- //! ``` use clap::{App, AppSettings, IntoApp, Parser, ValueHint}; use clap_complete::{generate, Generator, Shell}; use std::ffi::OsString; use std::io; use std::path::PathBuf; #[derive(Parser, Debug, PartialEq)] #[clap( name = "value_hints_derive", // AppSettings::TrailingVarArg is required to use ValueHint::CommandWithArguments setting = AppSettings::TrailingVarArg, )] struct Opt { /// If provided, outputs the completion file for given shell #[clap(long = "generate", arg_enum)] generator: Option, // Showcasing all possible ValueHints: #[clap(long, value_hint = ValueHint::Unknown)] unknown: Option, #[clap(long, value_hint = ValueHint::Other)] other: Option, #[clap(short, long, value_hint = ValueHint::AnyPath)] path: Option, #[clap(short, long, value_hint = ValueHint::FilePath)] file: Option, #[clap(short, long, value_hint = ValueHint::DirPath)] dir: Option, #[clap(short, long, value_hint = ValueHint::ExecutablePath)] exe: Option, #[clap(long, parse(from_os_str), value_hint = ValueHint::CommandName)] cmd_name: Option, #[clap(short, long, value_hint = ValueHint::CommandString)] cmd: Option, #[clap(value_hint = ValueHint::CommandWithArguments)] command_with_args: Vec, #[clap(short, long, value_hint = ValueHint::Username)] user: Option, #[clap(short, long, value_hint = ValueHint::Hostname)] host: Option, #[clap(long, value_hint = ValueHint::Url)] url: Option, #[clap(long, value_hint = ValueHint::EmailAddress)] email: Option, } fn print_completions(gen: G, app: &mut App) { generate(gen, app, app.get_name().to_string(), &mut io::stdout()); } fn main() { let opt = Opt::parse(); if let Some(generator) = opt.generator { let mut app = Opt::into_app(); eprintln!("Generating completion file for {:?}...", generator); print_completions(generator, &mut app); } else { println!("{:#?}", opt); } }