class

Optimist::Option

Inherits Reference < Object

Abstract base class for all other Options.

Constructors

new(name : String, desc : String, default : T, long : LongNameType = nil, alt : AlternatesType = nil, short : ShortNameType = nil, permitted : PermittedType = nil, callback : Option -> Nil | Nil = nil, permitted_response : String = "option '%{arg}' only accepts %{valid_string}", required : Bool = false, hidden : Bool = false, multi : Bool | Nil = nil) forall T

Class methods

create(name : String, desc : String, cls : Class | Nil = nil, default : _ = nil, **kwargs)

Factory class method Determines which type of object to create based on arguments passed to Optimist.opt. This is tricky because we allow the default to be able to set the option's type.

Instance methods

add_argument_value(a : Array(String), b : Bool)

default

desc

description_with_default(str)

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

description_with_permitted(str)

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

disallow_multiple_args(paramlist : Array(String))

doesnt_need_autogen_short

TODO: push into SHORT

educate

format_stdio(obj)

Format stdio like objects to a string

full_description

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

given?

long

max_args

min_args

name

needs_an_argument

permitted

permitted_response

permitted_type_valid?

permitted_value?(val : DefaultType) : Bool

Incoming values from the command-line should be strings, so we should stringify any permitted types as the basis of comparison.

required?

short

takes_an_argument

takes_multiple

trigger_callback

type_format

Provide type-format string. Default to empty, but should probably be overridden for most subclasses.

validate_permitted(arg : String, value : DefaultType) : Void

value