yargs-unparser

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.

The code originally lived in MOXY's GitHub but was later moved here for discoverability.

Installation

$ npm install yargs-unparser

Usage

1const parse = require('yargs-parser');
2const unparse = require('yargs-unparser');
3
4const argv = parse(['--no-boolean', '--number', '4', '--string', 'foo'], {
5    boolean: ['boolean'],
6    number: ['number'],
7    string: ['string'],
8});
9// { boolean: false, number: 4, string: 'foo', _: [] }
10
11const unparsedArgv = unparse(argv);
12// ['--no-boolean', '--number', '4', '--string', 'foo'];

The second argument of unparse accepts an options object:

• alias: The aliases so that duplicate options aren't generated
• default: The default values so that the options with default values are omitted
• command: The command first argument so that command names and positional arguments are handled correctly

Example with command options

1const yargs = require('yargs');
2const unparse = require('yargs-unparser');
3
4const argv = yargs
5    .command('my-command <positional>', 'My awesome command', (yargs) =>
6        yargs
7        .option('boolean', { type: 'boolean' })
8        .option('number', { type: 'number' })
9        .option('string', { type: 'string' })
10    )
11    .parse(['my-command', 'hello', '--no-boolean', '--number', '4', '--string', 'foo']);
12// { positional: 'hello', boolean: false, number: 4, string: 'foo', _: ['my-command'] }
13
14const unparsedArgv = unparse(argv, {
15    command: 'my-command <positional>',
16});
17// ['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.

If you coerce in weird ways, things might not work correctly.

Tests

$ npm test
$ npm test -- --watch during development

Supported Node.js Versions

Libraries in this ecosystem make a best effort to track Node.js' release schedule. Here's a post on why we think this is important.

License

MIT License