mirror of
https://github.com/clap-rs/clap
synced 2024-11-14 08:37:16 +00:00
a065702205
From a users perspective, `clap_derive` is baked into `clap`. `clap_generate is an add on to `clap`. So it seems best to have all `clap_generate` examples in `clap_generate` where a user will look for them. Fixes #2939
74 lines
2.6 KiB
Rust
74 lines
2.6 KiB
Rust
//! 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 --<TAB>
|
|
//! ```
|
|
//! fish:
|
|
//! ```sh
|
|
//! cargo run --example value_hints_derive -- --generate=fish > value_hints_derive.fish
|
|
//! . ./value_hints_derive.fish
|
|
//! ./target/debug/examples/value_hints_derive --<TAB>
|
|
//! ```
|
|
use clap::{App, AppSettings, IntoApp, Parser, ValueHint};
|
|
use clap_generate::{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<Shell>,
|
|
// Showcasing all possible ValueHints:
|
|
#[clap(long, value_hint = ValueHint::Unknown)]
|
|
unknown: Option<String>,
|
|
#[clap(long, value_hint = ValueHint::Other)]
|
|
other: Option<String>,
|
|
#[clap(short, long, value_hint = ValueHint::AnyPath)]
|
|
path: Option<PathBuf>,
|
|
#[clap(short, long, value_hint = ValueHint::FilePath)]
|
|
file: Option<PathBuf>,
|
|
#[clap(short, long, value_hint = ValueHint::DirPath)]
|
|
dir: Option<PathBuf>,
|
|
#[clap(short, long, value_hint = ValueHint::ExecutablePath)]
|
|
exe: Option<PathBuf>,
|
|
#[clap(long, parse(from_os_str), value_hint = ValueHint::CommandName)]
|
|
cmd_name: Option<OsString>,
|
|
#[clap(short, long, value_hint = ValueHint::CommandString)]
|
|
cmd: Option<String>,
|
|
#[clap(value_hint = ValueHint::CommandWithArguments)]
|
|
command_with_args: Vec<String>,
|
|
#[clap(short, long, value_hint = ValueHint::Username)]
|
|
user: Option<String>,
|
|
#[clap(short, long, value_hint = ValueHint::Hostname)]
|
|
host: Option<String>,
|
|
#[clap(long, value_hint = ValueHint::Url)]
|
|
url: Option<String>,
|
|
#[clap(long, value_hint = ValueHint::EmailAddress)]
|
|
email: Option<String>,
|
|
}
|
|
|
|
fn print_completions<G: Generator>(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);
|
|
}
|
|
}
|