clap_args 0.1.8

Lightweight wrapper for clap to auto-handle version and help / clap 轻量封装，自动处理版本与帮助
Documentation

English | 中文

clap_args : Lightweight Clap Wrapper for Automatic Version & Help Handling

A simplified wrapper around clap that streamlines command-line argument parsing by automatically handling version and help flags.

Table of Contents

Features

  • Automatic Versioning: Reads version directly from Cargo.toml.
  • Detailed Info: Provides platform and target information via --vv.
  • Built-in Help: Automatically handles -h and --help flags.
  • Macro Support: The parse! macro simplifies initialization.

Usage

Add to Cargo.toml:

[dependencies]
clap_args = { version = "*", features = ["macro"] }

Example

use clap_args::{arg, ArgAction};

fn main() -> aok::Result<()> {
  if let Some(matches) = clap_args::parse!(|cmd| {
    cmd
      .arg(arg!(-b --bind [BIND] "http proxy bind address").default_value("0.0.0.0:15080"))
      .arg(arg!(-p --port <PORT> "listen port"))
      .arg(arg!(-d --debug "enable debug mode").action(ArgAction::SetTrue))
  }) {
    let bind: &String = matches.get_one("bind").unwrap();
    println!("bind: {bind}");

    if let Some(port) = matches.get_one::<String>("port") {
      println!("port: {port}");
    }

    if matches.get_flag("debug") {
      println!("debug mode enabled");
    }
  }
  Ok(())
}

Design Philosophy

The core design goal is to reduce boilerplate for common CLI tasks.

Call Flow:

  1. Macro Invocation: parse! is called with a closure.
  2. Setup: The parse function initializes a clap::Command with default flags (-v, --vv, -h).
  3. User Configuration: The user-provided closure configures additional arguments.
  4. Execution: clap parses the arguments.
  5. Handling:
    • If version or help flags are present, they are handled immediately, and None is returned.
    • Otherwise, Some(ArgMatches) is returned for the user to process.

Tech Stack

  • Rust: Core language.
  • Clap: Underlying argument parser.
  • const_str: Compile-time string manipulation.
  • current_platform: Platform information retrieval.

Directory Structure

.
├── Cargo.toml      # Project configuration
├── examples/       # Usage examples
├── readme/         # Documentation
├── src/            # Source code
│   └── lib.rs      # Main library file
└── test.sh         # Test script

API Reference

parse! Macro

Initializes the parser with the current package name and version.

clap_args::parse!(|cmd| { ... })

parse Function

The underlying function called by the macro.

pub fn parse(
  project: impl Into<String>,
  ver: impl Borrow<[u64; 3]>,
  cmd_build: impl FnOnce(Command) -> Command,
) -> Option<ArgMatches>

Exports

  • arg!: Re-exported from clap for defining arguments.
  • ArgAction: Re-exported from clap for defining argument actions.

History

The concept of command-line arguments dates back to the early days of Unix in the 1970s. The argv (argument vector) convention allowed programs to receive input dynamically at runtime, a significant leap from hardcoded parameters. Over decades, parsing libraries evolved from simple loop-based checks to sophisticated frameworks like clap in Rust, which offer type safety, auto-generated help, and subcommands, reflecting the growing complexity and capability of modern CLI tools.

About

This project is an open-source component of js0.site ⋅ Refactoring the Internet Plan.

We are redefining the development paradigm of the Internet in a componentized way. Welcome to follow us:

clap_args : Clap 轻量封装，自动处理版本与帮助

clap 的简化封装，通过自动处理版本和帮助参数，简化命令行参数解析流程。

目录

特性

  • 自动版本管理: 直接读取 Cargo.toml 中的版本号。
  • 详细信息: 通过 --vv 提供平台和目标信息。
  • 内置帮助: 自动处理 -h 和 --help 参数。
  • 宏支持: parse! 宏简化初始化过程。

使用

添加到 Cargo.toml:

[dependencies]
clap_args = { version = "*", features = ["macro"] }

示例

use clap_args::{arg, ArgAction};

fn main() -> aok::Result<()> {
  if let Some(matches) = clap_args::parse!(|cmd| {
    cmd
      .arg(arg!(-b --bind [BIND] "http 代理绑定地址").default_value("0.0.0.0:15080"))
      .arg(arg!(-p --port <PORT> "监听端口"))
      .arg(arg!(-d --debug "启用调试模式").action(ArgAction::SetTrue))
  }) {
    let bind: &String = matches.get_one("bind").unwrap();
    println!("绑定: {bind}");

    if let Some(port) = matches.get_one::<String>("port") {
      println!("端口: {port}");
    }

    if matches.get_flag("debug") {
      println!("启用调试模式");
    }
  }
  Ok(())
}

设计思路

核心设计目标是减少通用 CLI 任务的样板代码。

调用流程:

  1. 宏调用: 用户调用 parse! 并传入闭包。
  2. 初始化: parse 函数初始化 clap::Command，配置默认参数（-v, --vv, -h）。
  3. 用户配置: 执行用户闭包，配置额外参数。
  4. 执行: clap 解析参数。
  5. 处理:
    • 若存在版本或帮助参数，立即处理并返回 None。
    • 否则，返回 Some(ArgMatches) 供用户处理。

技术堆栈

  • Rust: 核心语言。
  • Clap: 底层参数解析器。
  • const_str: 编译时字符串处理。
  • current_platform: 获取平台信息。

目录结构

.
├── Cargo.toml      # 项目配置
├── examples/       # 使用示例
├── readme/         # 文档
├── src/            # 源代码
│   └── lib.rs      # 主库文件
└── test.sh         # 测试脚本

API 参考

parse! 宏

使用当前包名和版本初始化解析器。

clap_args::parse!(|cmd| { ... })

parse 函数

宏调用的底层函数。

pub fn parse(
  project: impl Into<String>,
  ver: impl Borrow<[u64; 3]>,
  cmd_build: impl FnOnce(Command) -> Command,
) -> Option<ArgMatches>

导出

  • arg!: 从 clap 重新导出，用于定义参数。
  • ArgAction: 从 clap 重新导出，用于定义参数动作。

历史

命令行参数的概念可以追溯到 20 世纪 70 年代 Unix 的早期。argv（参数向量）约定允许程序在运行时动态接收输入，这是相对于硬编码参数的重大飞跃。几十年来，解析库从简单的循环检查演变为像 Rust 中的 clap 这样复杂的框架，提供类型安全、自动生成帮助和子命令支持，反映了现代 CLI 工具日益增长的复杂性和能力。

关于

本项目为 js0.site ⋅ 重构互联网计划 的开源组件。

我们正在以组件化的方式重新定义互联网的开发范式，欢迎关注：