Gathering detailed insights and metrics for @curlconverter/yargs-parser
Gathering detailed insights and metrics for @curlconverter/yargs-parser
a fork of the command line option parser used by yargs
Installations
npm install @curlconverter/yargs-parserDeveloper Guide
BETA
Typescript
No
Module System
ESM
Min. Node Version
>=10
Node Version
14.18.0
NPM Version
6.14.15
Score
91
Supply Chain
99.6
Quality
77.2
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Languages
3
JavaScript
TypeScript
HTML
JavaScript (66.81%)
TypeScript (32.83%)
HTML (0.36%)
Developer
curlconverter
Download Statistics
Total Downloads
1,974,887
Last Day
821
Last Week
9,983
Last Month
45,982
Last Year
1,126,661
GitHub Statistics
ISC License
342 Commits
1 Forks
2 Watchers
24 Branches
2 Contributors
Updated on Dec 30, 2022
Maintainers
1
Package Meta Information
Latest Version
0.0.1
Package Id
@curlconverter/yargs-parser@0.0.1
Size
27.20 kB
NPM Version
6.14.15
Node Version
14.18.0
Published on
Oct 20, 2021
Total Downloads
Cumulative downloads
Total Downloads
1,974,887
Last Day
-16.3%
821
Compared to previous day
Last Week
-13.6%
9,983
Compared to previous week
Last Month
-19.8%
45,982
Compared to previous month
Last Year
76.3%
1,126,661
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
23
yargs-parser
The mighty option parser used by yargs.
visit the yargs website for more examples, and thorough usage instructions.
Example
1npm i yargs-parser --save
1const argv = require('yargs-parser')(process.argv.slice(2)) 2console.log(argv)
1$ node example.js --foo=33 --bar hello 2{ _: [], foo: 33, bar: 'hello' }
or parse a string!
1const argv = require('yargs-parser')('--foo=99 --bar=33') 2console.log(argv)
1{ _: [], foo: 99, bar: 33 }
Convert an array of mixed types before passing to yargs-parser:
1const parse = require('yargs-parser') 2parse(['-f', 11, '--zoom', 55].join(' ')) // <-- array to string 3parse(['-f', 11, '--zoom', 55].map(String)) // <-- array of strings
Deno Example
As of v19 yargs-parser supports Deno:
1import parser from "https://deno.land/x/yargs_parser/deno.ts"; 2 3const argv = parser('--foo=99 --bar=9987930', { 4 string: ['bar'] 5}) 6console.log(argv)
ESM Example
As of v19 yargs-parser supports ESM (both in Node.js and in the browser):
Node.js:
1import parser from 'yargs-parser' 2 3const argv = parser('--foo=99 --bar=9987930', { 4 string: ['bar'] 5}) 6console.log(argv)
Browsers:
1<!doctype html> 2<body> 3 <script type="module"> 4 import parser from "https://unpkg.com/yargs-parser@19.0.0/browser.js"; 5 6 const argv = parser('--foo=99 --bar=9987930', { 7 string: ['bar'] 8 }) 9 console.log(argv) 10 </script> 11</body>
API
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 howargsshould 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']}.
Indicate that keys should be parsed as an array and coerced to booleans / numbers:
{array: [{ key: 'foo', boolean: true }, {key: 'bar', number: true}]}.opts.boolean: arguments should be parsed as booleans:{boolean: ['x', 'y']}.opts.coerce: provide a custom synchronous function that returns a coerced value from the argument provided (or throws an error). For arrays the function is called only once for the entire array:
{coerce: {foo: function (arg) {return modifiedArg}}}.opts.config: indicate a key that represents a path to a configuration file (this file will be loaded and parsed).opts.configObjects: configuration objects to parse, their properties will be set as arguments:
{configObjects: [{'x': 5, 'y': 33}, {'z': 44}]}.opts.configuration: provide configuration options to the yargs-parser (see: configuration).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 requiresnarguments:{narg: {x: 2}}.opts.normalize:path.normalize()will be applied to values set to this key.opts.number: keys should be treated as numbers.opts.string: keys should be treated as strings (even if they resemble a number-x 33).
returns:
obj: an object representing the parsed value ofargskey/value: key value pairs for each argument and their aliases._: an array representing the positional arguments.- [optional]
--: an array with arguments after the end-of-options flag--.
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 howargs, inputs are identical torequire('yargs-parser')(args, opts={}).
returns:
argv: an object representing the parsed value ofargskey/value: key value pairs for each argument and their aliases._: an array representing the positional arguments.- [optional]
--: an array with arguments after the end-of-options flag--.
error: populated with an error object if an exception occurred during parsing.aliases: the inferred list of aliases built by combining lists inopts.alias.newAliases: any new aliases added via camel-case expansion:boolean:{ fooBar: true }
defaulted: any new argument created byopts.default, no aliases included.boolean:{ foo: true }
configuration: given by default settings andopts.configuration.
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.
1var parsed = parser(['--no-dice'], { 2 configuration: { 3 'boolean-negation': false 4 } 5})
short option groups
- default:
true. - key:
short-option-groups.
Should a group of short-options be treated as boolean flags?
1$ node example.js -abc 2{ _: [], a: true, b: true, c: true }
if disabled:
1$ node example.js -abc 2{ _: [], abc: true }
camel-case expansion
- default:
true. - key:
camel-case-expansion.
Should hyphenated arguments be expanded into camel-case aliases?
1$ node example.js --foo-bar 2{ _: [], 'foo-bar': true, fooBar: true }
if disabled:
1$ node example.js --foo-bar 2{ _: [], 'foo-bar': true }
dot-notation
- default:
true - key:
dot-notation
Should keys that contain . be treated as objects?
1$ node example.js --foo.bar 2{ _: [], foo: { bar: true } }
if disabled:
1$ node example.js --foo.bar 2{ _: [], "foo.bar": true }
parse numbers
- default:
true - key:
parse-numbers
Should keys that look like numbers be treated as such?
1$ node example.js --foo=99.3 2{ _: [], foo: 99.3 }
if disabled:
1$ node example.js --foo=99.3 2{ _: [], foo: "99.3" }
parse positional numbers
- default:
true - key:
parse-positional-numbers
Should positional keys that look like numbers be treated as such.
1$ node example.js 99.3 2{ _: [99.3] }
if disabled:
1$ node example.js 99.3 2{ _: ['99.3'] }
boolean negation
- default:
true - key:
boolean-negation
Should variables prefixed with --no be treated as negations?
1$ node example.js --no-foo 2{ _: [], foo: false }
if disabled:
1$ node example.js --no-foo 2{ _: [], "no-foo": true }
combine arrays
- default:
false - key:
combine-arrays
Should arrays be combined when provided by both command line arguments and a configuration file.
duplicate arguments array
- default:
true - key:
duplicate-arguments-array
Should arguments be coerced into an array when duplicated:
1$ node example.js -x 1 -x 2 2{ _: [], x: [1, 2] }
if disabled:
1$ node example.js -x 1 -x 2 2{ _: [], x: 2 }
flatten duplicate arrays
- default:
true - key:
flatten-duplicate-arrays
Should array arguments be coerced into a single array when duplicated:
1$ node example.js -x 1 2 -x 3 4 2{ _: [], x: [1, 2, 3, 4] }
if disabled:
1$ node example.js -x 1 2 -x 3 4 2{ _: [], x: [[1, 2], [3, 4]] }
greedy arrays
- default:
true - key:
greedy-arrays
Should arrays consume more than one positional argument following their flag.
1$ node example --arr 1 2 2{ _: [], arr: [1, 2] }
if disabled:
1$ node example --arr 1 2 2{ _: [2], arr: [1] }
Note: in v18.0.0 we are considering defaulting greedy arrays to false.
nargs eats options
- default:
false - key:
nargs-eats-options
Should nargs consume dash options as well as positional arguments.
negation prefix
- default:
no- - key:
negation-prefix
The prefix to use for negated boolean variables.
1$ node example.js --no-foo 2{ _: [], foo: false }
if set to quux:
1$ node example.js --quuxfoo 2{ _: [], foo: false }
populate --
- default:
false. - key:
populate--
Should unparsed flags be stored in -- or _.
If disabled:
1$ node example.js a -b -- x y 2{ _: [ 'a', 'x', 'y' ], b: true }
If enabled:
1$ node example.js a -b -- x y 2{ _: [ 'a' ], '--': [ 'x', 'y' ], b: true }
set placeholder key
- default:
false. - key:
set-placeholder-key.
Should a placeholder be added for keys not set via the corresponding CLI argument?
If disabled:
1$ node example.js -a 1 -c 2 2{ _: [], a: 1, c: 2 }
If enabled:
1$ node example.js -a 1 -c 2 2{ _: [], a: 1, b: undefined, c: 2 }
halt at non-option
- default:
false. - key:
halt-at-non-option.
Should parsing stop at the first positional argument? This is similar to how e.g. ssh parses its command line.
If disabled:
1$ node example.js -a run b -x y 2{ _: [ 'b' ], a: 'run', x: 'y' }
If enabled:
1$ node example.js -a run b -x y 2{ _: [ 'b', '-x', 'y' ], a: 'run' }
strip aliased
- default:
false - key:
strip-aliased
Should aliases be removed before returning results?
If disabled:
1$ node example.js --test-field 1 2{ _: [], 'test-field': 1, testField: 1, 'test-alias': 1, testAlias: 1 }
If enabled:
1$ node example.js --test-field 1 2{ _: [], 'test-field': 1, testField: 1 }
strip dashed
- default:
false - key:
strip-dashed
Should dashed keys be removed before returning results? This option has no effect if
camel-case-expansion is disabled.
If disabled:
1$ node example.js --test-field 1 2{ _: [], 'test-field': 1, testField: 1 }
If enabled:
1$ node example.js --test-field 1 2{ _: [], testField: 1 }
unknown options as args
- default:
false - key:
unknown-options-as-args
Should unknown options be treated like regular arguments? An unknown option is one that is not
configured in opts.
If disabled
1$ node example.js --unknown-option --known-option 2 --string-option --unknown-option2 2{ _: [], unknownOption: true, knownOption: 2, stringOption: '', unknownOption2: true }
If enabled
1$ node example.js --unknown-option --known-option 2 --string-option --unknown-option2 2{ _: ['--unknown-option'], knownOption: 2, stringOption: '--unknown-option2' }
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.
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 beep boop \o/
License
ISC
No vulnerabilities found.