Shard Detail

parameters v1.0.4

Parse parameters from a string

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


parameters:
  github: erdnaxeli/crystal-parameters

Readme

crystal-parameters

Parse parameters from a string and output a array of strings that is usable with OptionParser#parse.

It is usefull on interactive app accepting complex commands, like text bots.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      crystal-parameters:
        github: erdnaxeli/crystal-parameters
    
  2. Run shards install

Usage

require "option_parser"
require "parameters"


parameters = Parameters.parse("ls -lh --author --hide '* *' /tmp")
# => ["ls", "-lh", "--author", "--hide", "* *", "/tmp"]

if parameters
  OptionParser.parse(parameters) do |parser|
    parser.on("ls", "list files") { }
  end
end

Development

Make sure to run make test and make lint :)

Contributing

  1. Fork it (https://github.com/erdnaxeli/crystal-parameters/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors