https://github.com/andywer/nanomist
A maintained and even tinier version of minimist
https://github.com/andywer/nanomist
Last synced: 9 months ago
JSON representation
A maintained and even tinier version of minimist
- Host: GitHub
- URL: https://github.com/andywer/nanomist
- Owner: andywer
- License: mit
- Created: 2017-07-19T20:43:25.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-19T20:44:25.000Z (almost 9 years ago)
- Last Synced: 2025-04-23T19:22:59.859Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://npmjs.com/nanomist
- Size: 68.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# nanomist
This package lets you parse command line arguments inside CLIs. It's a fork of [minimist](https://github.com/substack/minimist) (which is unmaintained and bigger on disk - in turn, we decided to create our own fork).
## Usage
First, install it:
```bash
npm install --save nanomist
```
Then you can start using it:
``` js
const flags = require('minimist')(process.argv.slice(2))
console.dir(flags)
```
Here's what the result will look like:
```
$ node example/parse.js -a beep -b boop
{ _: [], a: 'beep', b: 'boop' }
```
And another one with more flags:
```
$ 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' }
```
## API
``` js
const parseArgs = require('minimist')
```
## var argv = parseArgs(args, opts={})
Return an argument object `argv` populated with the array arguments from `args`.
`argv._` contains all the arguments that didn't have an option associated with
them.
Numeric-looking arguments will be returned as numbers unless `opts.string` or
`opts.boolean` is set for that argument name.
Any arguments after `'--'` will not be parsed and will end up in `argv._`.
options can be:
* `opts.string` - a string or array of strings argument names to always treat as
strings
* `opts.boolean` - a boolean, string or array of strings to always treat as
booleans. if `true` will treat all double hyphenated arguments without equal signs
as boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`)
* `opts.alias` - an object mapping string names to strings or arrays of string
argument names to use as aliases
* `opts.default` - an object mapping string argument names to default values
* `opts.stopEarly` - when true, populate `argv._` with everything after the
first non-option
* `opts['--']` - when true, populate `argv._` with everything before the `--`
and `argv['--']` with everything after the `--`. Here's an example:
```
> require('./')('one two three -- four five --six'.split(' '), { '--': true })
{ _: [ 'one', 'two', 'three' ],
'--': [ 'four', 'five', '--six' ] }
```
Note that with `opts['--']` set, parsing for arguments still stops after the
`--`.
* `opts.unknown` - a function which is invoked with a command line parameter not
defined in the `opts` configuration object. If the function returns `false`, the
unknown option is not added to `argv`.
## Authors
- James Halliday ([@substack](https://twitter.com/substack))
- Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo)) - [▲ZEIT](https://zeit.co)