7 releases (4 breaking)
0.5.2 | Jun 18, 2022 |
---|---|
0.5.1 | Jun 18, 2022 |
0.5.0 | Dec 2, 2021 |
0.4.0 | Dec 2, 2021 |
0.1.0 | Dec 1, 2021 |
#953 in Command-line interface
14KB
217 lines
argone
Most intuitive global cli maker. *(lazy_static + config-rs + clap)
| Examples | Docs | Latest Note |
[dependencies]
argone = "0.5"
Phases
- Parsing
clap
. - If clap-argument is
None
and the argument has[Config]
mark
then extract data fromConfig(file or env)
. - When the data is extracted and that was empty,
eventually set Default(=) value.
Example
* basics
use argone::{prelude::*, *};
ARGONE! {
version = "0.1"
author = "just-do-halee <just.do.halee@gmail.com>"
about = "this is our application"
Config {
// file's extension could be
// ini | json | json5 | yaml | toml | ron
file = "examples/Config"
// arg's env-prefix ex:) APP_...
prefix = "APP"
}
Args {
/// This is just one required argument.
/// and three slashes will be an 'about' for clap cli.
name: String
/// This argument is connected to Config(file or env).
/// Template is
/// [Config] $name: Option<$type> = Some($default_value) or
/// [Config] $name: Vec<$type> = vec![$default_values]
/// and this works in non-required argument.
[Config] age: Option<u8> = Some(12),
[Config] job: Vec<String>
// And all arugments are working on clap_derive format.
/// Exactly same with clap_derive.
(short, long)
parents: Vec<String>
/// But (default_value = "..") doesn't work to
/// the config arguments. instead, this would work.
(short, long, name = "WEIGHT")
[Config] weight: Option<u8> = Some(50)
/// In normal arguments, default_value will work.
(short, long, default_value = "1")
verbose: u8
}
commands = Sub
}
COMMANDS! {
Sub {
/// The subcommand
/// but subcommands do not have config arguments.
First {
version = "1.0"
author = "just-do-halee <just.do.halee@gmail.com>"
Args {
/// This area is also same.
test: String
}
}
Second {
about = "The second subcommand"
Args {
test: u8
}
}
}
}
fn main() {
println!("{:#?}", *ARGS);
if ARGS.name == "test" {
println!("name is test.");
}
if ARGS.age.unwrap() != 12 {
println!("age is not matching default 12.");
}
for job in &ARGS.job {
println!("job: {}", job);
}
for parents in &ARGS.parents {
println!("parent: {}", parents);
}
println!(
"weight is {}\nverbose is {}",
ARGS.weight.unwrap(),
ARGS.verbose
);
if let Some(sub) = &ARGS.commands {
match sub {
Sub::First { test } => println!("first command: {}", test),
Sub::Second { test } => println!("second command: {}", test),
}
} else {
println!("none subcommands");
}
}
Dependencies
~4.5MB
~90K SLoC