class Comandante::OptParser

• Comandante::OptParser
• Reference
• Object

Included Modules

• Comandante::OptParserTypes

Defined in:

Constant Summary

COLOR_OFF_OPT = OptionConfig.new(name: "no-color", short: "C", label: "color mode off.", action: ColorOffAction.new)

DEBUG_OPT = OptionConfig.new(name: "debug", short: "D", label: "debug mode.", action: DebugAction.new)

Built-ins

ERROR_MSGS = {invalid_option: "invalid option '%s'!", bad_command: "bad sub_command '%s'!", wrong_argument_count: "wrong argument count!", option_requires_value: "option --%s requires a value"}

TODO cleanups for this file :nodoc:

ROOT_ID = "/"

ID for the main command, used internally

VERBOSE_OPT = OptionConfig.new(name: "verbose", short: "v", label: "verbose mode.", simple_action: OptParser::OptProc.new do |v| Cleaner.verbose = true end)

VERSION_OPT = OptionConfig.new(name: "version", label: "display version and exit.", action: VersionAction.new)

Constructors

• .new(name, label, description = "", arguments_string = "", arguments_range = 0..MAX_ARGS)

  Creates the parser for the program.

Class Method Summary

• .assert_arg_count(args : Array(String), range : Range(Int32, Int32))

  Asserts argument count is in range, used internally, no need to call this directly

• .assert_option_value(opt, value)

  Asserts option has a value set or a default, used internally, no need to call this directly

• .version
• .version=(val : String)

Instance Method Summary

• #append(cmd : CommandConfig)

  Appends Configuration for a subcommand, including its options.

• #append_option(opt : OptionConfig, id = ROOT_ID)

  Appends configuration for an option, id is the name/id of the subcommand, when not given option is added to the main/root command.

• #args : Array(String)

  Arguments Parsed

• #auto_help : Bool

  Controls to add or not to add a help option to command+subcommands

• #auto_help=(auto_help : Bool)

  Controls to add or not to add a help option to command+subcommands

• #commands_str : String

  The header to user for subcommands (defaults are usually fine)

• #commands_str=(commands_str : String)

  The header to user for subcommands (defaults are usually fine)

• #max_width : Int32

  Controls Maximum text width

• #max_width=(max_width : Int32)

  Controls Maximum text width

• #options(id = ROOT_ID)

  Options Parsed

• #options_str : String

  The header to use for options (defaults are usually fine)

• #options_str=(options_str : String)

  The header to use for options (defaults are usually fine)

• #parse(args = ARGV, id = ROOT_ID)

  Do the actual parsing, called after all subcommands and options are added to OptParser object.

• #print_help(id = ROOT_ID)

  Is called automatically but just in case you want to call it manually

Constructor Detail

opts = OptParser.new(NAME, LABEL, DESC,
  argument_string: "FILE",
  argument_range: 1..1)

opts = OptParser.new(NAME, LABEL, DESC)

Class Method Detail

Instance Method Detail

opts.append(EVAL_OPTS)

opts.append_option(DEBUG_OPT)