Skip to content
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.

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

docs: correct typo in readme examples #358

Merged
merged 3 commits into from
Mar 8, 2021
Merged
Changes from all commits
Commits
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
136 changes: 68 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ const argv = require('yargs-parser')(process.argv.slice(2))
console.log(argv)
```

```sh
node example.js --foo=33 --bar hello
```console
$ node example.js --foo=33 --bar hello
{ _: [], foo: 33, bar: 'hello' }
```

Expand All @@ -34,7 +34,7 @@ const argv = require('yargs-parser')('--foo=99 --bar=33')
console.log(argv)
```

```sh
```console
{ _: [], foo: 99, bar: 33 }
```

Expand Down Expand Up @@ -174,15 +174,15 @@ var parsed = parser(['--no-dice'], {

Should a group of short-options be treated as boolean flags?

```sh
node example.js -abc
```console
$ node example.js -abc
{ _: [], a: true, b: true, c: true }
```

_if disabled:_

```sh
node example.js -abc
```console
$ node example.js -abc
{ _: [], abc: true }
```

Expand All @@ -193,15 +193,15 @@ node example.js -abc

Should hyphenated arguments be expanded into camel-case aliases?

```sh
node example.js --foo-bar
```console
$ node example.js --foo-bar
{ _: [], 'foo-bar': true, fooBar: true }
```

_if disabled:_

```sh
node example.js --foo-bar
```console
$ node example.js --foo-bar
{ _: [], 'foo-bar': true }
```

Expand All @@ -212,15 +212,15 @@ node example.js --foo-bar

Should keys that contain `.` be treated as objects?

```sh
node example.js --foo.bar
```console
$ node example.js --foo.bar
{ _: [], foo: { bar: true } }
```

_if disabled:_

```sh
node example.js --foo.bar
```console
$ node example.js --foo.bar
{ _: [], "foo.bar": true }
```

Expand All @@ -231,15 +231,15 @@ node example.js --foo.bar

Should keys that look like numbers be treated as such?

```sh
node example.js --foo=99.3
```console
$ node example.js --foo=99.3
{ _: [], foo: 99.3 }
```

_if disabled:_

```sh
node example.js --foo=99.3
```console
$ node example.js --foo=99.3
{ _: [], foo: "99.3" }
```

Expand All @@ -250,15 +250,15 @@ node example.js --foo=99.3

Should positional keys that look like numbers be treated as such.

```sh
node example.js 99.3
{ _: [99] }
```console
$ node example.js 99.3
{ _: [99.3] }
```

_if disabled:_

```sh
node example.js 99.3
```console
$ node example.js 99.3
{ _: ['99.3'] }
```

Expand All @@ -269,15 +269,15 @@ node example.js 99.3

Should variables prefixed with `--no` be treated as negations?

```sh
node example.js --no-foo
```console
$ node example.js --no-foo
{ _: [], foo: false }
```

_if disabled:_

```sh
node example.js --no-foo
```console
$ node example.js --no-foo
{ _: [], "no-foo": true }
```

Expand All @@ -296,15 +296,15 @@ a configuration file.

Should arguments be coerced into an array when duplicated:

```sh
node example.js -x 1 -x 2
```console
$ node example.js -x 1 -x 2
{ _: [], x: [1, 2] }
```

_if disabled:_

```sh
node example.js -x 1 -x 2
```console
$ node example.js -x 1 -x 2
{ _: [], x: 2 }
```

Expand All @@ -315,15 +315,15 @@ node example.js -x 1 -x 2

Should array arguments be coerced into a single array when duplicated:

```sh
node example.js -x 1 2 -x 3 4
```console
$ node example.js -x 1 2 -x 3 4
{ _: [], x: [1, 2, 3, 4] }
```

_if disabled:_

```sh
node example.js -x 1 2 -x 3 4
```console
$ node example.js -x 1 2 -x 3 4
{ _: [], x: [[1, 2], [3, 4]] }
```

Expand All @@ -334,15 +334,15 @@ node example.js -x 1 2 -x 3 4

Should arrays consume more than one positional argument following their flag.

```sh
node example --arr 1 2
```console
$ node example --arr 1 2
{ _[], arr: [1, 2] }
```

_if disabled:_

```sh
node example --arr 1 2
```console
$ node example --arr 1 2
{ _[2], arr: [1] }
```

Expand All @@ -362,15 +362,15 @@ Should nargs consume dash options as well as positional arguments.

The prefix to use for negated boolean variables.

```sh
node example.js --no-foo
```console
$ node example.js --no-foo
{ _: [], foo: false }
```

_if set to `quux`:_

```sh
node example.js --quuxfoo
```console
$ node example.js --quuxfoo
{ _: [], foo: false }
```

Expand All @@ -383,15 +383,15 @@ Should unparsed flags be stored in `--` or `_`.

_If disabled:_

```sh
node example.js a -b -- x y
```console
$ node example.js a -b -- x y
{ _: [ 'a', 'x', 'y' ], b: true }
```

_If enabled:_

```sh
node example.js a -b -- x y
```console
$ node example.js a -b -- x y
{ _: [ 'a' ], '--': [ 'x', 'y' ], b: true }
```

Expand All @@ -404,15 +404,15 @@ Should a placeholder be added for keys not set via the corresponding CLI argumen

_If disabled:_

```sh
node example.js -a 1 -c 2
```console
$ node example.js -a 1 -c 2
{ _: [], a: 1, c: 2 }
```

_If enabled:_

```sh
node example.js -a 1 -c 2
```console
$ node example.js -a 1 -c 2
{ _: [], a: 1, b: undefined, c: 2 }
```

Expand All @@ -425,15 +425,15 @@ Should parsing stop at the first positional argument? This is similar to how e.g

_If disabled:_

```sh
node example.js -a run b -x y
```console
$ node example.js -a run b -x y
{ _: [ 'b' ], a: 'run', x: 'y' }
```

_If enabled:_

```sh
node example.js -a run b -x y
```console
$ node example.js -a run b -x y
{ _: [ 'b', '-x', 'y' ], a: 'run' }
```

Expand All @@ -446,15 +446,15 @@ Should aliases be removed before returning results?

_If disabled:_

```sh
node example.js --test-field 1
```console
$ node example.js --test-field 1
{ _: [], 'test-field': 1, testField: 1, 'test-alias': 1, testAlias: 1 }
```

_If enabled:_

```sh
node example.js --test-field 1
```console
$ node example.js --test-field 1
{ _: [], 'test-field': 1, testField: 1 }
```

Expand All @@ -468,15 +468,15 @@ Should dashed keys be removed before returning results? This option has no effe

_If disabled:_

```sh
node example.js --test-field 1
```console
$ node example.js --test-field 1
{ _: [], 'test-field': 1, testField: 1 }
```

_If enabled:_

```sh
node example.js --test-field 1
```console
$ node example.js --test-field 1
{ _: [], testField: 1 }
```

Expand All @@ -490,15 +490,15 @@ configured in `opts`.

_If disabled_

```sh
node example.js --unknown-option --known-option 2 --string-option --unknown-option2
```console
$ node example.js --unknown-option --known-option 2 --string-option --unknown-option2
{ _: [], unknownOption: true, knownOption: 2, stringOption: '', unknownOption2: true }
```

_If enabled_

```sh
node example.js --unknown-option --known-option 2 --string-option --unknown-option2
```console
$ node example.js --unknown-option --known-option 2 --string-option --unknown-option2
{ _: ['--unknown-option'], knownOption: 2, stringOption: '--unknown-option2' }
```

Expand Down