clap-nested

方便的多层子命令命令行应用程序的 clap

• 如何安装？
• clap-nested 之所以存在的原因是什么？
• 用例
• 示例
• 文档 [↗]

安装

将 clap-nested 添加到您的 Cargo.toml

[dependencies]
clap-nested = "0.4.0"

原因？

首先，clap 是很棒的！

它提供了一个快速、易于使用且功能齐全的库，用于解析命令行参数以及子命令。

然而，尽管支持解析得很好，但在处理如何根据提供的参数和子命令来组织和执行逻辑时，clap 并没有太多意见。

这就是为什么我们经常在包含多层子命令的 CLI 应用程序中，将 clap 的解析结果与数十个子命令相匹配，更不用说大量参数了。这种糟糕的体验也会迅速升级，想象一下突然我们有很多子命令逻辑聚集在一个非常长的文件下。

因此，我们在 clap 中添加了一些意见，以帮助处理这个过程的不便。

用例

clap-nested 的主要用例、解释、理由和相关代码示例如下

• 简单的子命令和命令执行
• 直接的分层子命令
• 直接在错误上打印帮助信息

您可以在文档中找到更多信息。

示例

使用 clap-nested，我们可以以更组织的方式编写

// foo.rs
pub fn get_cmd<'a>() -> Command<'a, str> {
    Command::new(file_stem!())
        .description("Shows foo")
        .options(|app| {
            app.arg(
                Arg::with_name("debug")
                    .short("d")
                    .help("Prints debug information verbosely"),
            )
        })
        .runner(|args, matches| {
            let debug = clap::value_t!(matches, "debug", bool).unwrap_or_default();
            println!("Running foo, env = {}, debug = {}", args, debug);
            Ok(())
        })
}

// bar.rs
pub fn get_cmd<'a>() -> Command<'a, str> {
    Command::new(file_stem!())
        .description("Shows bar")
        .runner(|args, _matches| {
            println!("Running bar, env = {}", args);
            Ok(())
        })
}

// main.rs
fn main() {
    Commander::new()
        .options(|app| {
            app.arg(
                Arg::with_name("environment")
                    .short("e")
                    .long("env")
                    .global(true)
                    .takes_value(true)
                    .value_name("STRING")
                    .help("Sets an environment value, defaults to \"dev\""),
            )
        })
        .args(|_args, matches| matches.value_of("environment").unwrap_or("dev"))
        .add_cmd(foo::get_cmd())
        .add_cmd(bar::get_cmd())
        .no_cmd(|_args, _matches| {
            println!("No subcommand matched");
            Ok(())
        })
        .run();
}

请参阅 examples/clap_nested/ 和 examples/clap.rs 进行比较。

许可证

MIT 许可.