www.federated.computer/node_modules/yargs-parser
david@federated.company d975cc371d Fixes to NPM...
modified:   node_modules/.package-lock.json
	deleted:    node_modules/array-union/index.d.ts
	deleted:    node_modules/array-union/index.js
	deleted:    node_modules/array-union/license
	deleted:    node_modules/array-union/package.json
	deleted:    node_modules/array-union/readme.md
	modified:   node_modules/cliui/CHANGELOG.md
	modified:   node_modules/cliui/package.json
	modified:   node_modules/fast-glob/out/index.d.ts
	modified:   node_modules/fast-glob/out/index.js
	modified:   node_modules/fast-glob/out/managers/patterns.d.ts
	modified:   node_modules/fast-glob/out/managers/patterns.js
	modified:   node_modules/fast-glob/out/managers/tasks.d.ts
	modified:   node_modules/fast-glob/out/managers/tasks.js
	modified:   node_modules/fast-glob/out/providers/async.d.ts
	modified:   node_modules/fast-glob/out/providers/async.js
	modified:   node_modules/fast-glob/out/providers/filters/deep.d.ts
	modified:   node_modules/fast-glob/out/providers/filters/deep.js
	modified:   node_modules/fast-glob/out/providers/filters/entry.d.ts
	modified:   node_modules/fast-glob/out/providers/filters/entry.js
	modified:   node_modules/fast-glob/out/providers/filters/error.d.ts
	modified:   node_modules/fast-glob/out/providers/filters/error.js
	modified:   node_modules/fast-glob/out/providers/matchers/matcher.d.ts
	modified:   node_modules/fast-glob/out/providers/matchers/matcher.js
	modified:   node_modules/fast-glob/out/providers/matchers/partial.d.ts
	modified:   node_modules/fast-glob/out/providers/matchers/partial.js
	modified:   node_modules/fast-glob/out/providers/provider.d.ts
	modified:   node_modules/fast-glob/out/providers/provider.js
	modified:   node_modules/fast-glob/out/providers/stream.d.ts
	modified:   node_modules/fast-glob/out/providers/stream.js
	modified:   node_modules/fast-glob/out/providers/sync.d.ts
	modified:   node_modules/fast-glob/out/providers/sync.js
	modified:   node_modules/fast-glob/out/providers/transformers/entry.d.ts
	modified:   node_modules/fast-glob/out/providers/transformers/entry.js
	modified:   node_modules/fast-glob/out/readers/reader.d.ts
	modified:   node_modules/fast-glob/out/readers/reader.js
	modified:   node_modules/fast-glob/out/readers/stream.d.ts
	modified:   node_modules/fast-glob/out/readers/stream.js
	modified:   node_modules/fast-glob/out/readers/sync.d.ts
	modified:   node_modules/fast-glob/out/readers/sync.js
	modified:   node_modules/fast-glob/out/settings.d.ts
	modified:   node_modules/fast-glob/out/settings.js
	modified:   node_modules/fast-glob/out/types/index.d.ts
	modified:   node_modules/fast-glob/out/types/index.js
	modified:   node_modules/fast-glob/out/utils/array.d.ts
	modified:   node_modules/fast-glob/out/utils/array.js
	modified:   node_modules/fast-glob/out/utils/errno.d.ts
	modified:   node_modules/fast-glob/out/utils/errno.js
	modified:   node_modules/fast-glob/out/utils/fs.d.ts
	modified:   node_modules/fast-glob/out/utils/fs.js
	modified:   node_modules/fast-glob/out/utils/index.d.ts
	modified:   node_modules/fast-glob/out/utils/index.js
	modified:   node_modules/fast-glob/out/utils/path.d.ts
	modified:   node_modules/fast-glob/out/utils/path.js
	modified:   node_modules/fast-glob/out/utils/pattern.d.ts
	modified:   node_modules/fast-glob/out/utils/pattern.js
	modified:   node_modules/fast-glob/out/utils/stream.d.ts
	modified:   node_modules/fast-glob/out/utils/stream.js
	modified:   node_modules/fast-glob/out/utils/string.d.ts
	modified:   node_modules/fast-glob/out/utils/string.js
	modified:   node_modules/fast-glob/package.json
	modified:   node_modules/fastq/README.md
	modified:   node_modules/fastq/index.d.ts
	modified:   node_modules/fastq/package.json
	modified:   node_modules/fastq/queue.js
	modified:   node_modules/fastq/test/promise.js
	deleted:    node_modules/fs-extra/CHANGELOG.md
	modified:   node_modules/fs-extra/README.md
	deleted:    node_modules/fs-extra/lib/copy-sync/copy-sync.js
	deleted:    node_modules/fs-extra/lib/copy-sync/index.js
	modified:   node_modules/fs-extra/lib/copy/copy.js
	modified:   node_modules/fs-extra/lib/copy/index.js
	modified:   node_modules/fs-extra/lib/ensure/index.js
	modified:   node_modules/fs-extra/lib/fs/index.js
	modified:   node_modules/fs-extra/lib/index.js
	modified:   node_modules/fs-extra/lib/json/output-json-sync.js
	modified:   node_modules/fs-extra/lib/json/output-json.js
	deleted:    node_modules/fs-extra/lib/move-sync/index.js
	deleted:    node_modules/fs-extra/lib/move-sync/move-sync.js
	modified:   node_modules/fs-extra/lib/move/index.js
	modified:   node_modules/fs-extra/lib/move/move.js
	deleted:    node_modules/fs-extra/lib/output/index.js
	modified:   node_modules/fs-extra/lib/remove/index.js
	deleted:    node_modules/fs-extra/lib/remove/rimraf.js
	modified:   node_modules/fs-extra/package.json
	deleted:    node_modules/globby/gitignore.js
	modified:   node_modules/globby/index.d.ts
	modified:   node_modules/globby/index.js
	modified:   node_modules/globby/package.json
	modified:   node_modules/globby/readme.md
	deleted:    node_modules/globby/stream-utils.js
	deleted:    node_modules/globby/to-path.js
	modified:   node_modules/graceful-fs/LICENSE
	modified:   node_modules/graceful-fs/graceful-fs.js
	modified:   node_modules/graceful-fs/package.json
	modified:   node_modules/graceful-fs/polyfills.js
	modified:   node_modules/ignore/README.md
	modified:   node_modules/ignore/index.js
	modified:   node_modules/ignore/legacy.js
	modified:   node_modules/ignore/package.json
	modified:   node_modules/lilconfig/dist/index.js
	modified:   node_modules/lilconfig/package.json
	modified:   node_modules/lilconfig/readme.md
	deleted:    node_modules/micromatch/CHANGELOG.md
	modified:   node_modules/micromatch/README.md
	modified:   node_modules/micromatch/index.js
	modified:   node_modules/micromatch/package.json
	modified:   node_modules/nanoid/bin/nanoid.cjs
	modified:   node_modules/nanoid/index.browser.cjs
	modified:   node_modules/nanoid/index.browser.js
	deleted:    node_modules/nanoid/index.dev.js
	deleted:    node_modules/nanoid/index.prod.js
	modified:   node_modules/nanoid/nanoid.js
	modified:   node_modules/nanoid/package.json
	modified:   node_modules/postcss-cli/index.js
	modified:   node_modules/postcss-cli/package.json
	modified:   node_modules/postcss-load-config/README.md
	modified:   node_modules/postcss-load-config/package.json
	modified:   node_modules/postcss-load-config/src/index.d.ts
	modified:   node_modules/postcss-load-config/src/index.js
	modified:   node_modules/postcss-load-config/src/req.js
	modified:   node_modules/postcss/README.md
	modified:   node_modules/postcss/lib/at-rule.d.ts
	modified:   node_modules/postcss/lib/comment.d.ts
	modified:   node_modules/postcss/lib/container.d.ts
	modified:   node_modules/postcss/lib/container.js
	modified:   node_modules/postcss/lib/css-syntax-error.d.ts
	modified:   node_modules/postcss/lib/declaration.d.ts
	modified:   node_modules/postcss/lib/document.d.ts
	modified:   node_modules/postcss/lib/fromJSON.d.ts
	modified:   node_modules/postcss/lib/input.d.ts
	modified:   node_modules/postcss/lib/input.js
	modified:   node_modules/postcss/lib/lazy-result.d.ts
	modified:   node_modules/postcss/lib/list.d.ts
	modified:   node_modules/postcss/lib/list.js
	modified:   node_modules/postcss/lib/map-generator.js
	modified:   node_modules/postcss/lib/no-work-result.d.ts
	modified:   node_modules/postcss/lib/node.d.ts
	modified:   node_modules/postcss/lib/parse.d.ts
	modified:   node_modules/postcss/lib/parser.js
	modified:   node_modules/postcss/lib/postcss.d.ts
	modified:   node_modules/postcss/lib/postcss.js
	modified:   node_modules/postcss/lib/previous-map.d.ts
	modified:   node_modules/postcss/lib/processor.d.ts
	modified:   node_modules/postcss/lib/processor.js
	modified:   node_modules/postcss/lib/result.d.ts
	modified:   node_modules/postcss/lib/root.d.ts
	modified:   node_modules/postcss/lib/root.js
	modified:   node_modules/postcss/lib/rule.d.ts
	modified:   node_modules/postcss/lib/stringifier.d.ts
	modified:   node_modules/postcss/lib/stringify.d.ts
	modified:   node_modules/postcss/lib/warning.d.ts
	modified:   node_modules/postcss/package.json
	modified:   node_modules/slash/index.d.ts
	modified:   node_modules/slash/index.js
	modified:   node_modules/slash/package.json
	modified:   node_modules/slash/readme.md
	modified:   node_modules/yaml/LICENSE
	modified:   node_modules/yaml/README.md
	deleted:    node_modules/yaml/browser/dist/PlainValue-b8036b75.js
	deleted:    node_modules/yaml/browser/dist/Schema-e94716c8.js
	modified:   node_modules/yaml/browser/dist/index.js
	deleted:    node_modules/yaml/browser/dist/legacy-exports.js
	deleted:    node_modules/yaml/browser/dist/package.json
	deleted:    node_modules/yaml/browser/dist/parse-cst.js
	deleted:    node_modules/yaml/browser/dist/resolveSeq-492ab440.js
	deleted:    node_modules/yaml/browser/dist/types.js
	modified:   node_modules/yaml/browser/dist/util.js
	deleted:    node_modules/yaml/browser/dist/warnings-df54cb69.js
	modified:   node_modules/yaml/browser/index.js
	deleted:    node_modules/yaml/browser/map.js
	deleted:    node_modules/yaml/browser/pair.js
	deleted:    node_modules/yaml/browser/parse-cst.js
	deleted:    node_modules/yaml/browser/scalar.js
	deleted:    node_modules/yaml/browser/schema.js
	deleted:    node_modules/yaml/browser/seq.js
	deleted:    node_modules/yaml/browser/types.js
	deleted:    node_modules/yaml/browser/types/binary.js
	deleted:    node_modules/yaml/browser/types/omap.js
	deleted:    node_modules/yaml/browser/types/pairs.js
	deleted:    node_modules/yaml/browser/types/set.js
	deleted:    node_modules/yaml/browser/types/timestamp.js
	deleted:    node_modules/yaml/browser/util.js
	deleted:    node_modules/yaml/dist/Document-9b4560a1.js
	deleted:    node_modules/yaml/dist/PlainValue-ec8e588e.js
	deleted:    node_modules/yaml/dist/Schema-88e323a7.js
	modified:   node_modules/yaml/dist/index.js
	deleted:    node_modules/yaml/dist/legacy-exports.js
	deleted:    node_modules/yaml/dist/parse-cst.js
	deleted:    node_modules/yaml/dist/resolveSeq-d03cb037.js
	modified:   node_modules/yaml/dist/test-events.js
	deleted:    node_modules/yaml/dist/types.js
	modified:   node_modules/yaml/dist/util.js
	deleted:    node_modules/yaml/dist/warnings-1000a372.js
	deleted:    node_modules/yaml/index.d.ts
	deleted:    node_modules/yaml/index.js
	deleted:    node_modules/yaml/map.js
	modified:   node_modules/yaml/package.json
	deleted:    node_modules/yaml/pair.js
	deleted:    node_modules/yaml/parse-cst.d.ts
	deleted:    node_modules/yaml/parse-cst.js
	deleted:    node_modules/yaml/scalar.js
	deleted:    node_modules/yaml/schema.js
	deleted:    node_modules/yaml/seq.js
	deleted:    node_modules/yaml/types.d.ts
	deleted:    node_modules/yaml/types.js
	deleted:    node_modules/yaml/types.mjs
	deleted:    node_modules/yaml/types/binary.js
	deleted:    node_modules/yaml/types/omap.js
	deleted:    node_modules/yaml/types/pairs.js
	deleted:    node_modules/yaml/types/set.js
	deleted:    node_modules/yaml/types/timestamp.js
	modified:   node_modules/yaml/util.d.ts
	modified:   node_modules/yaml/util.js
	deleted:    node_modules/yaml/util.mjs
	modified:   node_modules/yargs-parser/CHANGELOG.md
	modified:   node_modules/yargs-parser/build/index.cjs
	modified:   node_modules/yargs-parser/build/lib/index.js
	modified:   node_modules/yargs-parser/build/lib/yargs-parser.js
	modified:   node_modules/yargs-parser/package.json
	modified:   node_modules/yargs/build/index.cjs
	modified:   node_modules/yargs/build/lib/command.js
	modified:   node_modules/yargs/build/lib/completion-templates.js
	modified:   node_modules/yargs/build/lib/completion.js
	modified:   node_modules/yargs/build/lib/usage.js
	modified:   node_modules/yargs/build/lib/validation.js
	modified:   node_modules/yargs/build/lib/yargs-factory.js
	modified:   node_modules/yargs/build/lib/yerror.js
	modified:   node_modules/yargs/lib/platform-shims/esm.mjs
	modified:   node_modules/yargs/locales/en.json
	modified:   node_modules/yargs/locales/fi.json
	modified:   node_modules/yargs/locales/ru.json
	modified:   node_modules/yargs/package.json
	modified:   package-lock.json
	modified:   package.json
	modified:   public/about/index.html
	modified:   public/access/index.html
	modified:   public/blog/index.html
	modified:   public/categories/index.html
	modified:   public/index.html
	modified:   public/manifesto/index.html
	modified:   public/posts/apple-breaks-privacy/index.html
	modified:   public/posts/index.html
	modified:   public/posts/main_street_against_big_tech/index.html
	modified:   public/posts/what_is_done_with_personal_data/index.html
	modified:   public/projects/index.html
	modified:   public/tags/index.html

	.hugo_build.lock
	go.mod
	go.sum
	node_modules/.bin/autoprefixer
	node_modules/.bin/browserslist
	node_modules/.bin/update-browserslist-db
	node_modules/autoprefixer/
	node_modules/browserslist/
	node_modules/caniuse-lite/
	node_modules/cliui/build/index.d.cts
	node_modules/electron-to-chromium/
	node_modules/fast-glob/out/readers/async.d.ts
	node_modules/fast-glob/out/readers/async.js
	node_modules/fraction.js/
	node_modules/fs-extra/lib/copy/copy-sync.js
	node_modules/fs-extra/lib/esm.mjs
	node_modules/fs-extra/lib/move/move-sync.js
	node_modules/fs-extra/lib/output-file/
	node_modules/globby/ignore.js
	node_modules/globby/node_modules/
	node_modules/globby/utilities.js
	node_modules/lilconfig/LICENSE
	node_modules/node-releases/
	node_modules/normalize-range/
	node_modules/postcss-value-parser/
	node_modules/postcss/lib/postcss.d.mts
	node_modules/update-browserslist-db/
	node_modules/yaml/browser/dist/compose/
	node_modules/yaml/browser/dist/doc/
	node_modules/yaml/browser/dist/errors.js
	node_modules/yaml/browser/dist/log.js
	node_modules/yaml/browser/dist/node_modules/
	node_modules/yaml/browser/dist/nodes/
	node_modules/yaml/browser/dist/parse/
	node_modules/yaml/browser/dist/public-api.js
	node_modules/yaml/browser/dist/schema/
	node_modules/yaml/browser/dist/stringify/
	node_modules/yaml/browser/dist/visit.js
	node_modules/yaml/browser/package.json
	node_modules/yaml/dist/compose/
	node_modules/yaml/dist/doc/
	node_modules/yaml/dist/errors.d.ts
	node_modules/yaml/dist/errors.js
	node_modules/yaml/dist/index.d.ts
	node_modules/yaml/dist/log.d.ts
	node_modules/yaml/dist/log.js
	node_modules/yaml/dist/nodes/
	node_modules/yaml/dist/options.d.ts
	node_modules/yaml/dist/parse/
	node_modules/yaml/dist/public-api.d.ts
	node_modules/yaml/dist/public-api.js
	node_modules/yaml/dist/schema/
	node_modules/yaml/dist/stringify/
	node_modules/yaml/dist/test-events.d.ts
	node_modules/yaml/dist/util.d.ts
	node_modules/yaml/dist/visit.d.ts
	node_modules/yaml/dist/visit.js
	node_modules/yargs/browser.d.ts
	node_modules/yargs/locales/cs.json
	node_modules/yargs/yargs.mjs
	public/css/main.min.c5514d3530979d291f3497facc20da1cec870028dbc2a3630b64bab8721bbe49.css
	resources/_gen/assets/sass/sass/style.sass_4d6f00452a35742ddbb489cb3703195e.content
	resources/_gen/assets/sass/sass/style.sass_4d6f00452a35742ddbb489cb3703195e.json
	resources/_gen/assets/sass/sass/style.sass_c87a2fc9dae9a546a3e3f1548c147175.content
	resources/_gen/assets/sass/sass/style.sass_c87a2fc9dae9a546a3e3f1548c147175.json
2023-04-21 10:12:50 -06:00
..
build Fixes to NPM... 2023-04-21 10:12:50 -06:00
browser.js Initial commit... 2023-04-21 08:57:54 -06:00
CHANGELOG.md Fixes to NPM... 2023-04-21 10:12:50 -06:00
LICENSE.txt Initial commit... 2023-04-21 08:57:54 -06:00
package.json Fixes to NPM... 2023-04-21 10:12:50 -06:00
README.md Initial commit... 2023-04-21 08:57:54 -06:00

yargs-parser

ci NPM version Conventional Commits nycrc config on GitHub

The mighty option parser used by yargs.

visit the yargs website for more examples, and thorough usage instructions.

Example

npm i yargs-parser --save
const argv = require('yargs-parser')(process.argv.slice(2))
console.log(argv)
$ node example.js --foo=33 --bar hello
{ _: [], foo: 33, bar: 'hello' }

or parse a string!

const argv = require('yargs-parser')('--foo=99 --bar=33')
console.log(argv)
{ _: [], foo: 99, bar: 33 }

Convert an array of mixed types before passing to yargs-parser:

const parse = require('yargs-parser')
parse(['-f', 11, '--zoom', 55].join(' '))   // <-- array to string
parse(['-f', 11, '--zoom', 55].map(String)) // <-- array of strings

Deno Example

As of v19 yargs-parser supports Deno:

import parser from "https://deno.land/x/yargs_parser/deno.ts";

const argv = parser('--foo=99 --bar=9987930', {
  string: ['bar']
})
console.log(argv)

ESM Example

As of v19 yargs-parser supports ESM (both in Node.js and in the browser):

Node.js:

import parser from 'yargs-parser'

const argv = parser('--foo=99 --bar=9987930', {
  string: ['bar']
})
console.log(argv)

Browsers:

<!doctype html>
<body>
  <script type="module">
    import parser from "https://unpkg.com/yargs-parser@19.0.0/browser.js";

    const argv = parser('--foo=99 --bar=9987930', {
      string: ['bar']
    })
    console.log(argv)
  </script>
</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 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']}.
      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 requires n arguments: {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 of args
    • key/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 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.
    • [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 in opts.alias.
  • newAliases: any new aliases added via camel-case expansion:
    • boolean: { fooBar: true }
  • defaulted: any new argument created by opts.default, no aliases included.
    • boolean: { foo: true }
  • configuration: given by default settings and opts.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.

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?

$ node example.js -abc
{ _: [], a: true, b: true, c: true }

if disabled:

$ node example.js -abc
{ _: [], abc: true }

camel-case expansion

  • default: true.
  • key: camel-case-expansion.

Should hyphenated arguments be expanded into camel-case aliases?

$ node example.js --foo-bar
{ _: [], 'foo-bar': true, fooBar: true }

if disabled:

$ node example.js --foo-bar
{ _: [], 'foo-bar': true }

dot-notation

  • default: true
  • key: dot-notation

Should keys that contain . be treated as objects?

$ node example.js --foo.bar
{ _: [], foo: { bar: true } }

if disabled:

$ 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?

$ node example.js --foo=99.3
{ _: [], foo: 99.3 }

if disabled:

$ node example.js --foo=99.3
{ _: [], foo: "99.3" }

parse positional numbers

  • default: true
  • key: parse-positional-numbers

Should positional keys that look like numbers be treated as such.

$ node example.js 99.3
{ _: [99.3] }

if disabled:

$ node example.js 99.3
{ _: ['99.3'] }

boolean negation

  • default: true
  • key: boolean-negation

Should variables prefixed with --no be treated as negations?

$ node example.js --no-foo
{ _: [], foo: false }

if disabled:

$ node example.js --no-foo
{ _: [], "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:

$ node example.js -x 1 -x 2
{ _: [], x: [1, 2] }

if disabled:

$ 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:

$ node example.js -x 1 2 -x 3 4
{ _: [], x: [1, 2, 3, 4] }

if disabled:

$ node example.js -x 1 2 -x 3 4
{ _: [], x: [[1, 2], [3, 4]] }

greedy arrays

  • default: true
  • key: greedy-arrays

Should arrays consume more than one positional argument following their flag.

$ node example --arr 1 2
{ _: [], arr: [1, 2] }

if disabled:

$ node example --arr 1 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.

$ node example.js --no-foo
{ _: [], foo: false }

if set to quux:

$ node example.js --quuxfoo
{ _: [], foo: false }

populate --

  • default: false.
  • key: populate--

Should unparsed flags be stored in -- or _.

If disabled:

$ node example.js a -b -- x y
{ _: [ 'a', 'x', 'y' ], b: true }

If enabled:

$ node example.js a -b -- x y
{ _: [ '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:

$ node example.js -a 1 -c 2
{ _: [], a: 1, c: 2 }

If enabled:

$ node example.js -a 1 -c 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:

$ node example.js -a run b -x y
{ _: [ 'b' ], a: 'run', x: 'y' }

If enabled:

$ node example.js -a run b -x y
{ _: [ 'b', '-x', 'y' ], a: 'run' }

strip aliased

  • default: false
  • key: strip-aliased

Should aliases be removed before returning results?

If disabled:

$ node example.js --test-field 1
{ _: [], 'test-field': 1, testField: 1, 'test-alias': 1, testAlias: 1 }

If enabled:

$ node example.js --test-field 1
{ _: [], '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:

$ node example.js --test-field 1
{ _: [], 'test-field': 1, testField: 1 }

If enabled:

$ node example.js --test-field 1
{ _: [], 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

$ node example.js --unknown-option --known-option 2 --string-option --unknown-option2
{ _: [], unknownOption: true, knownOption: 2, stringOption: '', unknownOption2: true }

If enabled

$ node example.js --unknown-option --known-option 2 --string-option --unknown-option2
{ _: ['--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