CLI Miami

# For the name-spaced methods CliMiami::A.sk & CliMiami::S.ay...
gem 'cli_miami'

# For the friendlier global methods A.sk & S.ay...
gem 'cli_miami', require: 'cli_miami/global'

S.ay 'Hello World', color: :red

S.ay 'Hello ', color: :red, newline: false
S.ay 'World', color: :blue

# passing the response to a block...
A.sk 'What is your name?', color: :yellow do |response|
  S.ay "Hello #{response}!", style: :bold
end

# returning the response through the `value` method
response = A.sk 'What is your name?', color: :yellow
S.ay "Hello #{response.value}!", style: :bold

A.sk 'What is your age?', type: :number

:array
:list             # Prompt for multiple responses for a single request

:boolean          # Prompt for true/false response

:dir
:directory
:file
:folder
:path             # Prompt for a local directory path

:fixnum
:integer
:number           # Prompt for an integer

:float            # Prompt for a decimal

:multiple_choice  # Prompt for values from a defined list of choices (see Validation Options below)

:hash
:object           # Prompt for key/value pairs

:range            # Prompt for a beginning and end numerical values

:string           # Prompt for text

:symbol           # Prompt for text that can convert to a proper ruby symbol

A.sk 'What is your age?', type: :number, min: 18, max: 99

:array
:list             
  :min            # The least amount of responses allowed
  :max            # The most amount of responses allowed
  :value_options  # An optional hash of Type Options & Validation Options to be applied to each response

:boolean
  'true'
  't'
  'yes'
  'y'             # The allowed values to represent `true`

  'false'
  'f'
  'no'
  'n'             # The allowed values to represent `false`

:dir
:directory
:file
:folder
:path             # Must be a valid, existing path to a local file or folder

:fixnum
:float            
:integer
:number           
  :min            # The lowest numerical value allowed
  :max            # The highest numerical value allowed

:multiple_choice
  :choices        # An Array or Hash of allowed values to choose from
                  # ['option 1', 'option 2', 'option 3']
                  # { one: 'option 1', two: 'option 2', three: 'option 3' }
  :min            # The least amount of responses allowed
  :max            # The most amount of responses allowed

:hash
:object           
  :keys           # An Array of keys that require a response
  :min            # The least amount of key/value responses allowed
  :max            # The most amount of key/value responses allowed
  :value_options  # An optional hash of Type Options & Validation Options to be applied to each response value

:range            
  :min            # The smallest range of numerical values allowed
  :max            # The largest range of numerical values allowed

:string           
  :min            # The least amount of characters allowed
  :max            # The most amount of characters allowed
  :regexp         # A regular expression the response must match

:symbol           
  :min            # The least amount of characters allowed
  :max            # The most amount of characters allowed
  :regexp         # A regular expression the response must match

color:      [symbol]             # See ansi color codes below
bgcolor:    [symbol]             # See ansi color codes below
style:      [symbol]             # See ansi style codes below. Can accept multiple styles as an array
justify:    [center|left|right]  # The type of justification to use
padding:    [integer]            # The maximum string size to justify text in
indent:     [integer]            # The number of characters to indent
newline:    [boolean]            # Set to true if you want a newline after the output

:black
:red
:green
:yellow
:blue
:magenta
:cyan
:white

:bold
:bright
:underline
:negative   # Swap foreground color with background color