|
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091 |
- # yargs-unparser
-
- [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url] [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url]
-
- [npm-url]:https://npmjs.org/package/yargs-unparser
- [npm-image]:http://img.shields.io/npm/v/yargs-unparser.svg
- [downloads-image]:http://img.shields.io/npm/dm/yargs-unparser.svg
- [travis-url]:https://travis-ci.org/yargs/yargs-unparser
- [travis-image]:http://img.shields.io/travis/yargs/yargs-unparser/master.svg
- [codecov-url]:https://codecov.io/gh/yargs/yargs-unparser
- [codecov-image]:https://img.shields.io/codecov/c/github/yargs/yargs-unparser/master.svg
- [david-dm-url]:https://david-dm.org/yargs/yargs-unparser
- [david-dm-image]:https://img.shields.io/david/yargs/yargs-unparser.svg
- [david-dm-dev-url]:https://david-dm.org/yargs/yargs-unparser?type=dev
- [david-dm-dev-image]:https://img.shields.io/david/dev/yargs/yargs-unparser.svg
- [greenkeeper-image]:https://badges.greenkeeper.io/yargs/yargs-unparser.svg
- [greenkeeper-url]:https://greenkeeper.io
-
- Converts back a `yargs` argv object to its original array form.
-
- Probably the unparser word doesn't even exist, but it sounds nice and goes well with [yargs-parser](https://github.com/yargs/yargs-parser).
-
- The code originally lived in [MOXY](https://github.com/moxystudio)'s GitHub but was later moved here for discoverability.
-
-
- ## Installation
-
- `$ npm install yargs-unparser`
-
-
- ## Usage
-
- ```js
- const parse = require('yargs-parser');
- const unparse = require('yargs-unparser');
-
- const argv = parse(['--no-boolean', '--number', '4', '--string', 'foo'], {
- boolean: ['boolean'],
- number: ['number'],
- string: ['string'],
- });
- // { boolean: false, number: 4, string: 'foo', _: [] }
-
- const unparsedArgv = unparse(argv);
- // ['--no-boolean', '--number', '4', '--string', 'foo'];
- ```
-
- The second argument of `unparse` accepts an options object:
-
- - `alias`: The [aliases](https://github.com/yargs/yargs-parser#requireyargs-parserargs-opts) so that duplicate options aren't generated
- - `default`: The [default](https://github.com/yargs/yargs-parser#requireyargs-parserargs-opts) values so that the options with default values are omitted
- - `command`: The [command](https://github.com/yargs/yargs/blob/master/docs/advanced.md#commands) first argument so that command names and positional arguments are handled correctly
-
- ### Example with `command` options
-
- ```js
- const yargs = require('yargs');
- const unparse = require('yargs-unparser');
-
- const argv = yargs
- .command('my-command <positional>', 'My awesome command', (yargs) =>
- yargs
- .option('boolean', { type: 'boolean' })
- .option('number', { type: 'number' })
- .option('string', { type: 'string' })
- )
- .parse(['my-command', 'hello', '--no-boolean', '--number', '4', '--string', 'foo']);
- // { positional: 'hello', boolean: false, number: 4, string: 'foo', _: ['my-command'] }
-
- const unparsedArgv = unparse(argv, {
- command: 'my-command <positional>',
- });
- // ['my-command', 'hello', '--no-boolean', '--number', '4', '--string', 'foo'];
- ```
-
- ### Caveats
-
- The returned array can be parsed again by `yargs-parser` using the default configuration. If you used custom configuration that you want `yargs-unparser` to be aware, please fill an [issue](https://github.com/yargs/yargs-unparser/issues).
-
- If you `coerce` in weird ways, things might not work correctly.
-
-
- ## Tests
-
- `$ npm test`
- `$ npm test -- --watch` during development
-
-
- ## License
-
- [MIT License](http://opensource.org/licenses/MIT)
|