|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257 |
- # yargs-parser
-
- [![Build Status](https://travis-ci.org/yargs/yargs-parser.png)](https://travis-ci.org/yargs/yargs-parser)
- [![Coverage Status](https://coveralls.io/repos/yargs/yargs-parser/badge.svg?branch=)](https://coveralls.io/r/yargs/yargs-parser?branch=master)
- [![NPM version](https://img.shields.io/npm/v/yargs-parser.svg)](https://www.npmjs.com/package/yargs-parser)
- [![Windows Tests](https://img.shields.io/appveyor/ci/bcoe/yargs-parser/master.svg?label=Windows%20Tests)](https://ci.appveyor.com/project/bcoe/yargs-parser)
- [![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
-
-
- The mighty option parser used by [yargs](https://github.com/yargs/yargs).
-
- visit the [yargs website](http://yargs.js.org/) for more examples, and thorough usage instructions.
-
- <img width="250" src="https://github.com/yargs/yargs-parser/blob/master/yargs-logo.png">
-
- ## Example
-
- ```sh
- npm i yargs-parser --save
- ```
-
- ```js
- var argv = require('yargs-parser')(process.argv.slice(2))
- console.log(argv)
- ```
-
- ```sh
- node example.js --foo=33 --bar hello
- { _: [], foo: 33, bar: 'hello' }
- ```
-
- _or parse a string!_
-
- ```js
- var argv = require('./')('--foo=99 --bar=33')
- console.log(argv)
- ```
-
- ```sh
- { _: [], foo: 99, bar: 33 }
- ```
-
- Convert an array of mixed types before passing to `yargs-parser`:
-
- ```js
- var parse = require('yargs-parser')
- parse(['-f', 11, '--zoom', 55].join(' ')) // <-- array to string
- parse(['-f', 11, '--zoom', 55].map(String)) // <-- array of strings
- ```
-
- ## API
-
- ### require('yargs-parser')(args, opts={})
-
- Parses command line arguments returning a simple mapping of keys and values.
-
- **expects:**
-
- * `args`: a string or array of strings representing the options to parse.
- * `opts`: provide a set of hints indicating how `args` should be parsed:
- * `opts.alias`: an object representing the set of aliases for a key: `{alias: {foo: ['f']}}`.
- * `opts.array`: indicate that keys should be parsed as an array: `{array: ['foo', 'bar']}`.
- * `opts.boolean`: arguments should be parsed as booleans: `{boolean: ['x', 'y']}`.
- * `opts.config`: indicate a key that represents a path to a configuration file (this file will be loaded and parsed).
- * `opts.coerce`: provide a custom synchronous function that returns a coerced value from the argument provided
- (or throws an error), e.g. `{coerce: {foo: function (arg) {return modifiedArg}}}`.
- * `opts.count`: indicate a key that should be used as a counter, e.g., `-vvv` = `{v: 3}`.
- * `opts.default`: provide default values for keys: `{default: {x: 33, y: 'hello world!'}}`.
- * `opts.envPrefix`: environment variables (`process.env`) with the prefix provided should be parsed.
- * `opts.narg`: specify that a key requires `n` arguments: `{narg: {x: 2}}`.
- * `opts.normalize`: `path.normalize()` will be applied to values set to this key.
- * `opts.string`: keys should be treated as strings (even if they resemble a number `-x 33`).
- * `opts.configuration`: provide configuration options to the yargs-parser (see: [configuration](#configuration)).
- * `opts.number`: keys should be treated as numbers.
-
- **returns:**
-
- * `obj`: an object representing the parsed value of `args`
- * `key/value`: key value pairs for each argument and their aliases.
- * `_`: an array representing the positional arguments.
-
- ### require('yargs-parser').detailed(args, opts={})
-
- Parses a command line string, returning detailed information required by the
- yargs engine.
-
- **expects:**
-
- * `args`: a string or array of strings representing options to parse.
- * `opts`: provide a set of hints indicating how `args`, inputs are identical to `require('yargs-parser')(args, opts={})`.
-
- **returns:**
-
- * `argv`: an object representing the parsed value of `args`
- * `key/value`: key value pairs for each argument and their aliases.
- * `_`: an array representing the positional arguments.
- * `error`: populated with an error object if an exception occurred during parsing.
- * `aliases`: the inferred list of aliases built by combining lists in `opts.alias`.
- * `newAliases`: any new aliases added via camel-case expansion.
- * `configuration`: the configuration loaded from the `yargs` stanza in package.json.
-
- <a name="configuration"></a>
- ### Configuration
-
- The yargs-parser applies several automated transformations on the keys provided
- in `args`. These features can be turned on and off using the `configuration` field
- of `opts`.
-
- ```js
- var parsed = parser(['--no-dice'], {
- configuration: {
- 'boolean-negation': false
- }
- })
- ```
-
- ### short option groups
-
- * default: `true`.
- * key: `short-option-groups`.
-
- Should a group of short-options be treated as boolean flags?
-
- ```sh
- node example.js -abc
- { _: [], a: true, b: true, c: true }
- ```
-
- _if disabled:_
-
- ```sh
- node example.js -abc
- { _: [], abc: true }
- ```
-
- ### camel-case expansion
-
- * default: `true`.
- * key: `camel-case-expansion`.
-
- Should hyphenated arguments be expanded into camel-case aliases?
-
- ```sh
- node example.js --foo-bar
- { _: [], 'foo-bar': true, fooBar: true }
- ```
-
- _if disabled:_
-
- ```sh
- node example.js --foo-bar
- { _: [], 'foo-bar': true }
- ```
-
- ### dot-notation
-
- * default: `true`
- * key: `dot-notation`
-
- Should keys that contain `.` be treated as objects?
-
- ```sh
- node example.js --foo.bar
- { _: [], foo: { bar: true } }
- ```
-
- _if disabled:_
-
- ```sh
- node example.js --foo.bar
- { _: [], "foo.bar": true }
- ```
-
- ### parse numbers
-
- * default: `true`
- * key: `parse-numbers`
-
- Should keys that look like numbers be treated as such?
-
- ```sh
- node example.js --foo=99.3
- { _: [], foo: 99.3 }
- ```
-
- _if disabled:_
-
- ```sh
- node example.js --foo=99.3
- { _: [], foo: "99.3" }
- ```
-
- ### boolean negation
-
- * default: `true`
- * key: `boolean-negation`
-
- Should variables prefixed with `--no` be treated as negations?
-
- ```sh
- node example.js --no-foo
- { _: [], foo: false }
- ```
-
- _if disabled:_
-
- ```sh
- node example.js --no-foo
- { _: [], "no-foo": true }
- ```
-
- ### duplicate arguments array
-
- * default: `true`
- * key: `duplicate-arguments-array`
-
- Should arguments be coerced into an array when duplicated:
-
- ```sh
- node example.js -x 1 -x 2
- { _: [], x: [1, 2] }
- ```
-
- _if disabled:_
-
- ```sh
- node example.js -x 1 -x 2
- { _: [], x: 2 }
- ```
-
- ### flatten duplicate arrays
-
- * default: `true`
- * key: `flatten-duplicate-arrays`
-
- Should array arguments be coerced into a single array when duplicated:
-
- ```sh
- node example.js -x 1 2 -x 3 4
- { _: [], x: [1, 2, 3, 4] }
- ```
-
- _if disabled:_
-
- ```sh
- node example.js -x 1 2 -x 3 4
- { _: [], x: [[1, 2], [3, 4]] }
- ```
-
- ## Special Thanks
-
- The yargs project evolves from optimist and minimist. It owes its
- existence to a lot of James Halliday's hard work. Thanks [substack](https://github.com/substack) **beep** **boop** \o/
-
- ## License
-
- ISC
|