combu

combu is a customizable cli framework. The library name "combu" comes from command + 昆布(konbu, it means kelp in japanese).

combu has no dependencies(or depends on only std library). Crate.io's page is here.

combu(com + 昆布)は柔軟に CLI を組み上げられることを目標とした、カスタマイズ可能な CLI フレームワークです（一時クレートの名前が cmb だったこともありましたが、現在は combu です）。

Features

• Unix 形式でのフラグパース
• サブコマンド（多重可能）
• No dependencies(combu depends on only std library)
• seahorse を参考にした Bool, String, Int, Float の型つきフラグ
• コモンフラグ、ローカルフラグ形式
• サブコマンド前のフラグの受付
• 独自でパース等を行いたい場合に再利用できる構造体の設定
  • 似たような CLI フレームワークを作りたいときに使用できる部品を用意
• カスタマイズできるヘルプ表示(一応)
• エラーハンドリングに関して、ある程度の自由度を持たせた設計

Documentation

Here

Installation to your project

Combu exists on crates.io.

You can use(or import) this crate like other crate that exists on crates.io.

Edit cargo.toml manually

Add

toml combu="[version you want to use]"

to cargo.toml.

Use cargo-edit (Recommended)

If you installed cargo-edit, exec below command under the target project:

bash cargo add combu

Quick Start

```rust use combu::{ActionError, ActionResult, Command, Context, Flag, FlagValue}; use std::env;

fn main() { Command::new() .name(env!("CARGOPKGNAME")) .authors(env!("CARGOPKGAUTHORS")) .version(env!("CARGOPKGVERSION")) .usage(env!("CARGOPKGNAME").tostring() + " [args]") .commonflag(Flag::newbool("help").shortalias('h')) .action(act) .runfromargs(env::args().collect()) }

fn act(c: Context) -> Result { if Some(FlagValue::Bool(true)) == c.getflagvalue_of("help") { return Ok(ActionResult::ShowHelpRequest(c)); } println!("Hello, combu - {:?}", c.args); Ok(ActionResult::Done) } ```

If you want to run quick start as example, exec

bash cargo run --example quick_start cargo run --example quick_start --help

Example

Simple (command has flags, but not has subcommand)

Code

```rust use combu::{ActionError, ActionResult, Command, Context, Flag, FlagValue}; use std::env;

fn main() { Command::withname("single") .action(act) .localflag(Flag::newbool("reverse").shortalias('r')) .single_run(env::args().collect::>()); }

fn act(c: Context) -> Result { let r = c.getflagvalue_of("reverse").unwrap();

println!(
    "{:?}",
    match r {
        FlagValue::Bool(true) => {
            c.args
                .iter()
                .rev()
                .fold(String::new(), |concated, arg| concated + arg)
        }
        _ => {
            c.args
                .iter()
                .fold(String::new(), |concated, arg| concated + arg)
        }
    }
);
Ok(ActionResult::Done)

}

```

Run

bash $ cargo run --example single a b c d e abcde $ cargo run --example single a b c d e -r edcba

Multi (Use Sub command)

Code

```rust use combu::{ActionError, ActionResult, Command, Context, Flag, FlagValue};

fn main() { rootcommand().runfrom_args(std::env::args().collect()) }

fn rootcommand() -> Command { Command::withname("multi") .commonflag(Flag::newbool("help").shortalias('h')) .commonflag(Flag::newbool("reverse").shortalias('r')) .localflag(Flag::newbool("by-char").shortalias('c')) .action(printargs) .subcommand(addcommand()) .subcommand(subcommand()) } fn callhelp(c: Context) -> Result { Ok(ActionResult::ShowHelpRequest(c)) } fn printargs(context: Context) -> Result { if calledhelp(&context) { return callhelp(context); } let r: bool = context.getflagvalueof("reverse") == Some(FlagValue::Bool(true)); let c: bool = context.getflagvalueof("by-char") == Some(FlagValue::Bool(true)); let str = { let str = if r && !c { context .args .iter() .rev() .fold(String::new(), |c, arg| c + arg) } else { context.args.iter().fold(String::new(), |c, arg| c + arg) }; if c { str.chars().rev().collect::() } else { str } };

println!("{}", str);

Ok(ActionResult::Done)

}

fn calledhelp(c: &Context) -> bool { Some(FlagValue::Bool(true)) == c.getflagvalueof("help") }

fn addcommand() -> Command { Command::new() .name("add") .alias("a") .action(addaction) .localflag(Flag::newbool("detail").short_alias('d')) }

fn addaction(c: Context) -> Result { if calledhelp(&c) { return callhelp(c); } let f = |(str, sum), num: f64| (format!("{} {} +", str, num), sum + num); let (mut str, sum): (String, f64) = if c.getflagvalueof("reverse") == Some(FlagValue::Bool(true)) { c.args .iter() .rev() .filtermap(|arg| arg.parse().ok()) .fold((String::new(), 0.0), f) } else { c.args .iter() .filtermap(|arg| arg.parse().ok()) .fold((String::new(), 0.0), f) }; str.pop(); str.pop();

if c.get_flag_value_of("detail").unwrap().is_bool_true() {
    println!("{} = {}", str, sum);
} else {
    println!("{}", sum);
}
Ok(ActionResult::Done)

}

fn subcommand() -> Command { Command::new() .name("sub") .alias("s") .action(subaction) .localflag(Flag::newbool("sort").short_alias('s')) }

fn subaction(c: Context) -> Result { if calledhelp(&c) { return callhelp(c); } let f = |(str, sum), (index, num): (usize, f64)| { ( format!("{} {} -", str, num), if index < 1 { num } else { sum - num }, ) }; let filtermapf = |arg: &String| arg.parse().ok(); let (mut str, result): (String, f64) = if c.getflagvalueof("reverse") == Some(FlagValue::Bool(true)) { c.args .iter() .rev() .filtermap(filtermapf) .enumerate() .fold((String::new(), 0.0), f) } else if c.getflagvalueof("sort").unwrap().isbooltrue() { let mut fvec = c.args.iter().filtermap(filtermapf).collect::>(); fvec.sortby(|a, b| a.partialcmp(b).unwrap()); fvec .itermut() .enumerate() .fold((String::new(), 0.0), |s, (index, fl)| f(s, (index, *fl))) } else { c.args .iter() .filtermap(filtermap_f) .enumerate() .fold((String::new(), 0.0), f) }; str.pop(); str.pop();

println!("{} = {}", str, result);

Ok(ActionResult::Done)

} ```

Run

bash cargo run --example multi -- a 1 2 3 4 5 15 cargo run --example multi -- s 1 2 3 4 5 -13

Inspired

• cobra (Golang package for making cli)
• seahorse (A minimal CLI framework written in Rust)
• clap(Rust crate for making cli)

TODO(or Features to be implemented)

• ドキュメントコメントを分かりやすくする(いつになるかは無期限未定)
• 必要そうなテストの実装(command.rs のフラグ解析テストは実装した)
• コマンド構築にあたってのプリセット実装

License

This is licensed under MIT LICENSE