README
Tr
BasicValue
Tr
Value
T
Arg
- ::choicesArg::choices
- ::commonArg::common
- ::defaultsArg::defaults
- ::flagArg::flag
- ::is_globalArg::is_global
- ::namedArg::named
- ::nargsArg::nargs
- ::positionalArg::positional
- ::shortArg::short
- ::value_delimiterArg::value_delimiter
T
CommonFields
T
Nargs
- ::is_exceededNargs::is_exceeded
- ::is_valid_lengthNargs::is_valid_length
T
Parser
- ::gen_help_messageParser::gen_help_message
- ::newParser::new
- ::parseParser::parse
T
SimpleValue
- ::get_arraySimpleValue::get_array
- ::get_flagSimpleValue::get_flag
- ::get_oneSimpleValue::get_one
- ::get_optionSimpleValue::get_option
- ::get_positionalSimpleValue::get_positional
- ::newSimpleValue::new
T
SubCommand
- ::newSubCommand::new

clap

Command Line Argument Parser

utils

command line

parser

moon add TheWaWaR/clap@0.2.6

Download zip

Author

TheWaWaR

Version

0.2.6

License

MIT

Repository

github.com/TheWaWaR/clap.mbt

Last updated

9 months ago

Downloads

README

#clap.mbt

Command Line Argument Parser for MoonBit

#Features

Support flag/named/positional arguments
Support limit arguments length
Support argument choices/default values
Support global argument
Support env variables as default value
Support infinite level of sub-command
Support custom value type
Support generate clap-rs style help output
When named argument length full filled immediately finish current argument

#Usage

Here is a simple example:

let parser = Parser::new(subcmds={
  "subcmd1": SubCommand::new(
    args={ "arg1": Arg::flag(short='a', help="Argument 1") },
    help="Test subcommand",
  ),
})
let value = SimpleValue::new(parser.prog)
let help_message = parser.parse!(value, ["subcmd1", "--arg1"])
assert_eq!(help_message, None)
assert_eq!(value.name, "PROG")
assert_eq!(value.args.length(), 0)
assert_eq!(value.flags.is_empty(), true)
assert_eq!(value.positional_args.is_empty(), true)
assert_eq!(value.subcmd.unwrap().flags.get("arg1").unwrap(), true)

Generate the help message:

let value = SimpleValue::new(parser.prog)
let help_message = parser.parse!(value, ["--help"]).unwrap()
let expected_help_message =
  #|Usage: PROG [OPTIONS] <COMMAND>
  #|
  #|Commands:
  #|  subcmd1  Test subcommand
  #|
  #|Options:
  #|  -h, --help  Print help
  #|
assert_eq!(help_message, expected_help_message)

See more examples: parser tests

#
BasicValue

source

pub(open) trait BasicValue {
  parse(input : String) -> Self raise @moonbitlang/core/strconv.StrConvError
StrConvError
}

impl BasicValue for Int

impl BasicValue for Int64

impl BasicValue for UInt

impl BasicValue for UInt64

impl BasicValue for Double

impl BasicValue for String

#
Value

source

pub(open) trait Value {
  set_flag(Self, name : String, value : Bool) -> Unit raise ParserError = _
  add_value(Self, name : String, value : String, positional : Bool) -> Unit raise ParserError = _
  select_subcmd(Self, subcmd : String) -> Self raise ParserError = _
}

#
ParserError

source

pub(all) suberror ParserError {
  InvalidArgumentName(String)
  InvalidSubCommandName(String)
  InvalidPositionalAsNamed(String)
  InvalidArgumentValue(String)
  InvalidArgumentValueLength(String)
  TooManyArgs(String)
  InvalidSpec(String)
}

impl Show for ParserError

#
Arg

source

pub(all) enum Arg {
  Flag(Char, Bool, Bool, CommonFields)
  Named(Char, Nargs, @moonbitlang/core/hashset.HashSet
HashSet[String], ArrayView[String], Bool, String, CommonFields)
  Positional(Nargs, @moonbitlang/core/hashset.HashSet
HashSet[String], ArrayView[String], String, CommonFields)
}

#
Arg::choices

source

fn Arg::choices(self : Arg) -> @moonbitlang/core/hashset.HashSet
HashSet[String]?

#
Arg::common

source

fn Arg::common(self : Arg) -> CommonFields

#
Arg::defaults

source

fn Arg::defaults(self : Arg) -> ArrayView[String]

#
Arg::flag

source

fn Arg::flag(short? : Char, store? : Bool, global? : Bool, env_var? : String, help? : String) -> Arg

Create a flag argument

#
Arg::is_global

source

fn Arg::is_global(self : Arg) -> Bool

#
Arg::named

source

fn Arg::named(short? : Char, nargs? : Nargs, choices? : @moonbitlang/core/hashset.HashSet
HashSet[String], defaults? : ArrayView[String], global? : Bool, value_delimiter? : String, env_var? : String, help? : String) -> Arg

Create a named argument

#
Arg::nargs

source

fn Arg::nargs(self : Arg) -> Nargs?

#
Arg::positional

source

fn Arg::positional(nargs? : Nargs, choices? : @moonbitlang/core/hashset.HashSet
HashSet[String], defaults? : ArrayView[String], value_delimiter? : String, env_var? : String, help? : String) -> Arg

Create a positional argument

#
Arg::short

source

fn Arg::short(self : Arg) -> Char?

#
Arg::value_delimiter

source

fn Arg::value_delimiter(self : Arg) -> String?

#
CommonFields

source

pub struct CommonFields {
  env_var : String
  help : String
}

#
Nargs

source

pub(all) enum Nargs {
  Any
  One
  Fixed(UInt)
  AtLeast(UInt)
  AtMost(UInt)
  Range(UInt, UInt)
}

impl Eq for Nargs

impl Show for Nargs

#
Nargs::is_exceeded

source

fn Nargs::is_exceeded(self : Nargs, length : UInt) -> Bool

Check if the length exceeded the max length

#
Nargs::is_valid_length

source

fn Nargs::is_valid_length(self : Nargs, length : UInt) -> Bool

Check if the length is constrained by Nargs

#
Parser

source

pub(all) struct Parser {
  prog : String
  args : Map[String, Arg]
  subcmds : Map[String, SubCommand]
  description : String
}

#
Parser::gen_help_message

source

fn Parser::gen_help_message(self : Parser, subcmd_chains : Array[String], global_args : Map[String, Arg]) -> String

Generate the help message

#
Parser::new

source

fn Parser::new(prog? : String, args? : Map[String, Arg], subcmds? : Map[String, SubCommand], description? : String) -> Parser

Create the argument parser specification

#
Parser::parse

source

fn[V : Value] Parser::parse(self : Parser, value : V, cli_args : ArrayView[String], env_vars? : Map[String, String]) -> String? raise ParserError

Parse the command line arguments

#
SimpleValue

source

pub(all) struct SimpleValue {
  name : String
  args : @moonbitlang/core/hashmap.HashMap
HashMap[String, Array[String]]
  flags : @moonbitlang/core/hashmap.HashMap
HashMap[String, Bool]
  positional_args : Array[String]
  subcmd : SimpleValue?
}

impl Value for SimpleValue

fn add_value(self : SimpleValue, name : String, value : String, positional : Bool) -> Unit raise ParserError

source

fn select_subcmd(self : SimpleValue, subcmd : String) -> SimpleValue raise ParserError

source

fn set_flag(self : SimpleValue, name : String, value : Bool) -> Unit raise ParserError

source

impl Eq for SimpleValue

impl Show for SimpleValue

#
SimpleValue::get_array

source

fn[T : BasicValue] SimpleValue::get_array(self : SimpleValue, name : String) -> Array[T] raise ParserError

Get multiple values by the argument name

#
SimpleValue::get_flag

source

fn SimpleValue::get_flag(self : SimpleValue, name : String) -> Bool?

#
SimpleValue::get_one

source

fn[T : BasicValue] SimpleValue::get_one(self : SimpleValue, name : String) -> T raise ParserError

Get exactly one value by the argument name

#
SimpleValue::get_option

source

fn[T : BasicValue] SimpleValue::get_option(self : SimpleValue, name : String) -> T? raise ParserError

Get one/zero value by the argument name

#
SimpleValue::get_positional

source

fn[T : BasicValue] SimpleValue::get_positional(self : SimpleValue) -> Array[T] raise ParserError

Get the positional argument values

#
SimpleValue::new

source

fn SimpleValue::new(name : String) -> SimpleValue

Create a simple value to hold the parsed result

#
SubCommand

source

pub(all) struct SubCommand {
  args : Map[String, Arg]
  subcmds : Map[String, SubCommand]
  help : String
}

#
SubCommand::new

source

fn SubCommand::new(args? : Map[String, Arg], subcmds? : Map[String, SubCommand], help? : String) -> SubCommand

Create a subcommand specification

Source Files

Site source Report issue Packages Build queue Skills Statistics

clap

#clap.mbt

#Features

#Usage

#BasicValue

#Value

#ParserError

#Arg

#Arg::choices

#Arg::common

#Arg::defaults

#Arg::flag

#Arg::is_global

#Arg::named

#Arg::nargs

#Arg::positional

#Arg::short

#Arg::value_delimiter

#CommonFields

#Nargs

#Nargs::is_exceeded

#Nargs::is_valid_length

#Parser

#Parser::gen_help_message

#Parser::new

#Parser::parse

#SimpleValue

#SimpleValue::get_array

#SimpleValue::get_flag

#SimpleValue::get_one

#SimpleValue::get_option

#SimpleValue::get_positional

#SimpleValue::new

#SubCommand

#SubCommand::new

Source Files

#
BasicValue

#
Value

#
ParserError

#
Arg

#
Arg::choices

#
Arg::common

#
Arg::defaults

#
Arg::flag

#
Arg::is_global

#
Arg::named

#
Arg::nargs

#
Arg::positional

#
Arg::short

#
Arg::value_delimiter

#
CommonFields

#
Nargs

#
Nargs::is_exceeded

#
Nargs::is_valid_length

#
Parser

#
Parser::gen_help_message

#
Parser::new

#
Parser::parse

#
SimpleValue

#
SimpleValue::get_array

#
SimpleValue::get_flag

#
SimpleValue::get_one

#
SimpleValue::get_option

#
SimpleValue::get_positional

#
SimpleValue::new

#
SubCommand

#
SubCommand::new