argwerk

通过声明式宏定义简单命令行解析器。

这**不是**一个完整的命令行解析器库。相反，它可以作为一个快速且便宜的选择，可以轻松地集成到工具中。

对于更完整的命令行解析库，请使用clap。

我们提供

• 使用声明式宏的无依赖命令行解析框架。
• 灵活的解析机制。
• 美观的帮助信息格式化。

我们不提供

• 尽可能接近正确的宽Unicode字符行包装（见textwrap）。
• 内置复杂命令结构，如子命令（见子命令示例，了解如何实现）。

有关用法，请参阅argwerk::define和argwerk::args的文档。

用法

最初在您向程序添加参数时，可以使用argwerk::args。这允许轻松解析少量可选参数。

此示例作为simple提供。

cargo run --example simple -- --limit 20

let args = argwerk::args! {
    /// A simple tool.
    "tool [-h]" {
        help: bool,
        limit: usize = 10,
    }
    /// The limit of the operation. (default: 10).
    ["-l" | "--limit", int] => {
        limit = str::parse(&int)?;
    }
    /// Print this help.
    ["-h" | "--help"] => {
        println!("{}", HELP);
        help = true;
    }
}?;

if args.help {
    return Ok(());
}

dbg!(args);

一段时间后，您可能希望升级到定义包含参数的命名结构。如果您想传递参数，这可能很有用。

此示例作为tour提供。

cargo run --example tour -- --help

use std::ffi::OsString;

argwerk::define! {
    /// A command touring the capabilities of argwerk.
    #[derive(Default)]
    #[usage = "tour [-h]"]
    struct Args {
        help: bool,
        #[required = "--file must be specified"]
        file: String,
        input: Option<String>,
        limit: usize = 10,
        positional: Option<(String, Option<String>)>,
        raw: Option<OsString>,
        rest: Vec<String>,
    }
    /// Prints the help.
    ///
    /// This includes:
    ///    * All the available switches.
    ///    * All the available positional arguments.
    ///    * Whatever else the developer decided to put in here! We even support wrapping comments which are overly long.
    ["-h" | "--help"] => {
        println!("{}", Args::help());
        help = true;
    }
    /// Limit the number of things by <n> (default: 10).
    ["--limit" | "-l", n] => {
        limit = str::parse(&n)?;
    }
    /// Write to the file specified by <path>.
    ["--file", path] if !file.is_some() => {
        file = Some(path);
    }
    /// Read from the specified input.
    ["--input", #[option] path] => {
        input = path;
    }
    /// A really long argument that exceeds usage limit and forces the documentation to wrap around with newlines.
    ["--really-really-really-long-argument", thing] => {
    }
    /// A raw argument that passes whatever was passed in from the operating system.
    ["--raw", #[os] arg] => {
        raw = Some(arg);
    }
    /// Takes argument at <foo> and <bar>.
    ///
    ///    * This is an indented message. The first alphanumeric character determines the indentation to use.
    [foo, #[option] bar, #[rest] args] if positional.is_none() => {
        positional = Some((foo, bar));
        rest = args;
    }
}

// Note: we're using `parse` here instead of `args` since it works better
// with the example.
let args = Args::parse(vec!["--file", "foo.txt", "--input", "-"])?;

dbg!(args);

与其他项目的时间和时间大小比较

argwerk旨在成为一个轻量级的依赖项，编译速度快。在这方面，它与其他项目相比是这样的。

以下摘要是从这里找到的项目生成的。

**: 重建是由向 main.rs 添加单个换行符触发的。
**: argh 0.1.4 包括11个依赖项。
***: clap 3.0.0-beta.2 包括32个依赖项。

您可以尝试使用以下方式自行构建：

cargo run --manifest-path tools/builder/Cargo.toml