mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 14:52:33 +00:00
d840d5650e
Before #2005, `Clap` was a special trait that derived all clap traits it detected were relevant (including an enum getting both `ArgEnum`, `Clap`, and `Subcommand`). Now, we have elevated `Clap`, `Args`, `Subcommand`, and `ArgEnum` to be user facing but the name `Clap` isn't very descriptive. This also helps further clarify the relationships so a crate providing an item to be `#[clap(flatten)]` or `#[clap(subcommand)]` is more likely to choose the needed trait to derive. Also, my proposed fix fo #2785 includes making `App` attributes almost exclusively for `Clap`. Clarifying the names/roles will help communicate this. For prior discussion, see #2583
74 lines
2.5 KiB
Rust
74 lines
2.5 KiB
Rust
//! Example on how the `rename_all` parameter works.
|
|
//!
|
|
//! `rename_all` can be used to override the casing style used during argument
|
|
//! generation. By default the `kebab-case` style will be used but there are a wide
|
|
//! variety of other styles available.
|
|
//!
|
|
//! ## Supported styles overview:
|
|
//!
|
|
//! - **Camel Case**: Indicate word boundaries with uppercase letter, excluding
|
|
//! the first word.
|
|
//! - **Kebab Case**: Keep all letters lowercase and indicate word boundaries
|
|
//! with hyphens.
|
|
//! - **Pascal Case**: Indicate word boundaries with uppercase letter,
|
|
//! including the first word.
|
|
//! - **Screaming Snake Case**: Keep all letters uppercase and indicate word
|
|
//! boundaries with underscores.
|
|
//! - **Snake Case**: Keep all letters lowercase and indicate word boundaries
|
|
//! with underscores.
|
|
//! - **Verbatim**: Use the original attribute name defined in the code.
|
|
|
|
use clap::Parser;
|
|
|
|
#[derive(Parser, Debug)]
|
|
#[clap(name = "rename_all", rename_all = "screaming_snake_case")]
|
|
enum Opt {
|
|
// This subcommand will be named `FIRST_COMMAND`. As the command doesn't
|
|
// override the initial casing style, ...
|
|
/// A screaming loud first command. Only use if necessary.
|
|
FirstCommand {
|
|
// this flag will be available as `--FOO` and `-F`.
|
|
/// This flag will even scream louder.
|
|
#[clap(long, short)]
|
|
foo: bool,
|
|
},
|
|
|
|
// As we override the casing style for this variant the related subcommand
|
|
// will be named `SecondCommand`.
|
|
/// Not nearly as loud as the first command.
|
|
#[clap(rename_all = "pascal_case")]
|
|
SecondCommand {
|
|
// We can also override it again on a single field.
|
|
/// Nice quiet flag. No one is annoyed.
|
|
#[clap(rename_all = "snake_case", long)]
|
|
bar_option: bool,
|
|
|
|
// Renaming will not be propagated into subcommand flagged enums. If
|
|
// a non default casing style is required it must be defined on the
|
|
// enum itself.
|
|
#[clap(subcommand)]
|
|
cmds: Subcommands,
|
|
|
|
// or flattened structs.
|
|
#[clap(flatten)]
|
|
options: BonusOptions,
|
|
},
|
|
}
|
|
|
|
#[derive(Parser, Debug)]
|
|
enum Subcommands {
|
|
// This one will be available as `first-subcommand`.
|
|
FirstSubcommand,
|
|
}
|
|
|
|
#[derive(Parser, Debug)]
|
|
struct BonusOptions {
|
|
// And this one will be available as `baz-option`.
|
|
#[clap(long)]
|
|
baz_option: bool,
|
|
}
|
|
|
|
fn main() {
|
|
let opt = Opt::parse();
|
|
println!("{:?}", opt);
|
|
}
|