1.0.1 • Published 1 year ago

cli-args-parse-dashdash-2402-pmb v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

cli-args-parse-dashdash-2402-pmb

Yet another arguments parser. Similar to minimist but --optname yields { optname: true } rather than eating the next argument.

API

This module exports one function:

parseArgs(input)

input is an array of CLI arguments.

Returns an array whose first item is a plain object with "keyed options" (see below), potentially followed by "raw" arguments (see below).

Four types of arguments are recognized:

  • --key=value: Keyed argument, where both key and value are strings, potentially empty.
  • --key: Keyed argument, where key is a non-empty string. The value will be boolean true.
  • --: Ignored, but all remaining arguments are treated as "raw".
  • (any other): Raw argument.

In key names, all dashes (-) are replaced with low line (_).

Usage

see test/usage.js.

Known issues

  • Needs more/better tests and docs.

 

License

ISC