argwerk

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

这不是一个完整的命令行解析器库。相反，这可以作为一个替代的快速且简单的方案，可以廉价地集成到工具中。

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

我们提供

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

我们不提供

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

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

示例

最初，当你在程序中添加参数时，可以使用 argwerk_no_std::args。这允许轻松解析出一些可选参数。

此示例作为 simple 提供

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

let args = argwerk_no_std::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_no_std::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

许可协议：MIT/Apache-2.0