dargs-fork

Patch for the dargs package, that adds support for single flags. Convert an object of options into an array of command-line arguments.

See readme of dargs!

That's just a fork with patch for single flag support, sindresorhus/dargs#32 - PRs there are welcome, so if you want create one and please ping me. :)

Install

Install with npm

1$ npm i dargs-fork --save

Usage

For more use-cases see the tests

1const dargs = require('dargs-fork')
2
3const input = {
4    _: ['some', 'option'],          // values in '_' will be appended to the end of the generated argument list
5    foo: 'bar',
6    hello: true,                    // results in only the key being used
7    cake: false,                    // prepends `no-` before the key
8    camelCase: 5,                   // camelCase is slugged to `camel-case`
9    multiple: ['value', 'value2'],  // converted to multiple arguments
10    pieKind: 'cherry',
11    sad: ':('
12}
13
14const excludes = ['sad', /.*Kind$/]  // excludes and includes accept regular expressions
15const includes = ['camelCase', 'multiple', 'sad', /^pie.*/]
16const aliases = {file: 'f'}
17
18console.log(dargs(input, {excludes}))
19/*
20[
21    '--foo=bar',
22    '--hello',
23    '--no-cake',
24    '--camel-case=5',
25    '--multiple=value',
26    '--multiple=value2',
27    'some',
28    'option'
29]
30*/
31
32console.log(dargs(input, {excludes, includes}))
33/*
34[
35    '--camel-case=5',
36    '--multiple=value',
37    '--multiple=value2'
38]
39*/
40
41console.log(dargs(input, {includes}))
42/*
43[
44    '--camel-case=5',
45    '--multiple=value',
46    '--multiple=value2',
47    '--pie-kind=cherry',
48    '--sad=:('
49]
50*/
51
52console.log(dargs({
53    foo: 'bar',
54    hello: true,
55    file: 'baz'
56}, {aliases}))
57/*
58[
59    '--foo=bar',
60    '--hello',
61    '-f', 'baz'
62]
63*/

Related

• dargs: Reverse minimist. Convert an object of options into an array of command-line… more | homepage
• gitclone-cli: Simple command line interface for the git clone command, using gitclone and… more | homepage
• gitclone: Powerful and flexible programmatic interface for the git clone command, using [gitclone-defaults… more | homepage
• minibase: MiniBase is minimalist approach to Base - @node-base, the awesome framework. Foundation… more | homepage
• unzy: Minimalist, extremely pluggable, programmatic Git interface for node.js, built on MiniBase. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent