yargs-parser

What is yargs-parser?

The yargs-parser package is a Node.js library that parses command line arguments. It takes an array of arguments, typically process.argv, and generates an object with the parsed keys and values. It supports various features such as boolean flags, numbers, strings, arrays, and nested objects.

What are yargs-parser's main functionalities?

Boolean Flags

Parses command line flags (e.g., --debug) as boolean values. If a flag is present without a value, it is set to true; otherwise, it is set to false.

{"_": [], "debug": true, "verbose": false}

Numbers

Automatically detects and parses numeric arguments, allowing you to specify numbers on the command line.

{"_": [], "port": 8080}

Strings

Parses command line arguments as strings, ensuring that numeric values or flags are treated as text.

{"_": [], "host": "localhost"}

Arrays

Supports array arguments, allowing multiple values to be collected into a single array.

{"_": [], "files": ["file1.txt", "file2.txt"]}

Nested Objects

Allows for nested object structures, enabling complex configurations to be passed via the command line.

{"_": [], "config": {"url": "http://example.com", "port": 80}}

Other packages similar to yargs-parser

commander

Commander is another popular npm package for parsing command line options. It provides a high-level API for defining commands, options, and handling input. Commander is more feature-rich and is designed for building complex CLI applications, whereas yargs-parser is a lower-level tool for argument parsing.

minimist

Minimist is a minimalistic argument parsing library. It is simpler and has fewer features compared to yargs-parser, making it a good choice for smaller projects or when you need a lightweight solution.

meow

Meow is a CLI app helper that wraps around minimist. It provides a more user-friendly interface and additional features like help text generation. Meow is more opinionated than yargs-parser and is designed for quick CLI development.

arg

Arg is a simple argument parser with a focus on performance and strict type validation. It is less feature-rich than yargs-parser but offers a straightforward API for projects that require strict type checks.

README

yargs-parser

The mighty option parser used by yargs.

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

Example

npm i yargs-parser --save

var 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!

var argv = require('./')('--foo=99 --bar=33');
console.log(argv)

{ _: [], foo: 99, bar: 33 }

API

require('yargs-parser')(args, opts={})

Parses command line arguments returning a simple mapping of keys and values.

expects:

• args: an array or string 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']}.
  • opts.boolean: arguments should be parsed as booleans: {boolean: ['x', 'y']}.
  • opts.config: indicate a key that represents a path to a configuration file (this file will be loaded and parsed).
  • 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.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.

require('yargs-parser').detailed(args, opts={})

Parses a command line string, returning detailed information required by the yargs engine.

expects:

• args: an array or string 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.
• 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.
• configuration: the configuration loaded from the yargs stanza in package.json.

Configuration

The yargs-parser applies several automated transformations on the keys provided in args. These features can be turned on and off by using the yargs configuration stanza in your package.json:

{
  "name": "my-awesome-module",
  "yargs": {
    "dot-notation": 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" }

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 }

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

Changelog

21.1.1 (2022-08-04)

Bug Fixes

• typescript: ignore .cts files during publish (#454) (d69f9c3), closes #452