berdon/minimist2

TypeScript/JavaScript ES6 rewrite of popular Minimist argument parser

Minimist2

Minimist2 is a rewrite of the popular Minimist Javascript library for argument parsing. The library aims to be a drop-in replacement with matching API footprint. It passes all original Minimist unit tests.

Minimist2 is written in TypeScript targetting ES6.

Installing

npm install minimist2

Development

1. Checkout the code

   git clone [email protected]:berdon/minimist2.git
   npm install

2. Develop
3. Run tests

   npm test

4. Submit a pull request

Using

var argv = require('minimist2')(process.argv.slice(2));
console.dir(argv);

$ node example/parse.js -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }

$ node example/parse.js -x 3 -y 4 -n5 -abc --beep=boop foo bar baz
{ _: [ 'foo', 'bar', 'baz' ],
  x: 3,
  y: 4,
  n: 5,
  a: true,
  b: true,
  c: true,
  beep: 'boop' }

minimist2's Issues

feature request: @types/minimist2

It can help to solve warnings like:

Could not find a declaration file for module 'minimist2'. '~/node_modules/minimist2/lib/index.min.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/minimist2` if it exists or add a new declaration (.d.ts) file containing `declare module 'minimist2';`ts(7016)