Skip to content

Update readme.md #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jsumners wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −4
Open

Update readme.md #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Quickly scan for CLI flags and arguments

This is a [fast](#benchmarks) and lightweight alternative to [`minimist`](https://github.com/substack/minimist) and [`yargs-parser`](https://github.com/yargs/yargs-parser).
This is a [fast](#benchmarks) and lightweight alternative to [`minimist`](https://github.com/minimistjs/minimist) and [`yargs-parser`](https://github.com/yargs/yargs-parser).

It only exists because I find that I usually don't need most of what `minimist` and `yargs-parser` have to offer. However, `mri` is similar _enough_ that it might function as a "drop-in replacement" for you, too!

Expand Down Expand Up @@ -118,9 +118,9 @@ Once an unknown flag is encountered, parsing will terminate, regardless of your
- Missing `options`:
- `opts.stopEarly`
- `opts['--']`
- Ignores newlines (`\n`) within args (see [test](https://github.com/substack/minimist/blob/master/test/parse.js#L69-L80))
- Ignores slashBreaks within args (see [test](https://github.com/substack/minimist/blob/master/test/parse.js#L147-L157))
- Ignores dot-nested flags (see [test](https://github.com/substack/minimist/blob/master/test/parse.js#L180-L197))
- Ignores newlines (`\n`) within args (see [test](https://github.com/minimistjs/minimist/blob/2edc957fb668c81e2bd9e93748866a30ab33b28e/test/parse.js#L71-L82))
- Ignores slashBreaks within args (see [test](https://github.com/minimistjs/minimist/blob/2edc957fb668c81e2bd9e93748866a30ab33b28e/test/parse.js#L159-L169))
- Ignores dot-nested flags (see [test](https://github.com/minimistjs/minimist/blob/2edc957fb668c81e2bd9e93748866a30ab33b28e/test/parse.js#L192-L209))

#### yargs-parser

Expand Down