optionator

  "author": "George Zahariev <z@georgezahariev.com>",

  "bugs": "https://github.com/gkz/optionator/issues",

      "url": "https://raw.github.com/gkz/optionator/master/LICENSE"

    "url": "git://github.com/gkz/optionator.git"

Optionator is an option parsing and help generation library. It uses [type-check](https://github.com/gkz/type-check) and [levn](https://github.com/gkz/levn) behind the scenes to cast and verify input according the specified types. It can accept an array of arguments (like from `process.argv`), a string, or an object.

Unlike other libraries, optionator prefers to fail with helpful error messages rather than silently accept poor input.

    Invalid option '--halp' - perhaps you meant '--help'?

    Invalid value for option 'count' - expected type Int, received value: str.

For updates on optionator, [follow me on twitter](https://twitter.com/gkzahariev).

`require('optionator');` returns a function. It has one property, `VERSION`, the current version of the library as a string. This function is called with an object specifying your options and other information, see the [settings format section](#settings-format). This in turn returns an object with three properties, `parse`, `generateHelp`, and `generateHelpForOption`, which are all functions.

`parse` processes the `input` according to your settings, and returns an object with the results.

* input - `[String] | Object | String` - the input you wish to parse

* options - `{slice: Int}` - the only current option is `slice`, which specifies how much to slice away from the beginning if the input is an array or string - by default `0` for string, `2` for array (works with `process.argv`)

`Object` - the parsed options, each key is a camelCase version of the option name (specified in dash-case), and each value is the processed value for that option. Positional values are in an array under the `_` key.

parse(['node', 't.js', '--count', '2', 'positional']); // {count: 2, _: ['positional']}

parse('--count 2 positional');                         // {count: 2, _: ['positional']}

parse({count: 2, _:['positional']});                   // {count: 2, _: ['positional']}

`generateHelp` produces help text based on your settings.

* options - `{showHidden: Boolean}` - the only current option is `showHidden`, which specifies whether to show options with `hidden: true` specified, by default it is `false`

`generateHelpForOption` produces expanded help text for the specified with `optionName` option. If an `example` was specified for the option, it will be displayed,  and if a `longDescription` was specified, it will display that instead of the `description`.

* optionName - `String` - the name of the option to display

`String` - the generated help text for the option

When your `require('optionator')`, you get a function that takes in a settings object. This object has the type:

		{
		"name": "optionator",
		"version": "0.1.0",
		"version": "0.1.1",
		"author": "George Zahariev <z@georgezahariev.com>",
		@@ -36,3 +36,3 @@ "description": "option parsing",
		"type-check": "~0.3.0",
		"levn": "~0.2.0",
		"levn": "~0.2.1",
		"levenshtein-damerau": "~0.1.0"
		@@ -39,0 +39,0 @@ },

		@@ -14,3 +14,3 @@ # optionator

		MIT license. Version 0.1.0.
		MIT license. Version 0.1.1.

		@@ -17,0 +17,0 @@ npm install optionator

Dependency changes