Class Optimist::Option
In: lib/optimist.rb
Parent: Object

Methods

array_default?   callback   create   desc   description_with_default   educate   flag?   multi   multi?   multi_arg?   new   opts   opts=   parse   register_alias   required?   short?   single_arg?   type_format  

Attributes

default  [RW] 
long  [RW] 
multi_given  [W] 
name  [RW] 
short  [RW] 

Public Class methods

create(name, desc="", opts={}, settings={})

Determines which type of object to create based on arguments passed to +Optimist::opt+. This is trickier in Optimist, than other cmdline parsers (e.g. Slop) because we allow the +default:+ to be able to set the option‘s type.

register_alias(*alias_keys)

Provide a way to register symbol aliases to the Parser

Public Instance methods

array_default?()

note: Option-Types with both multi_arg? and flag? false are single-parameter (normal) options.

description_with_default()

Format the educate-line description including the default-value(s)

flag?()

Indicates a flag option, which is an option without an argument

multi?()

Alias for multi

multi_arg?()

Indicates that this is a multivalued (Array type) argument

type_format()

provide type-format string. default to empty, but user should probably override it

[Validate]