Skip to content

Make README examples follow eslint rules #35

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

Merged
bcoe merged 1 commit into from
Jan 12, 2022
Merged

Make README examples follow eslint rules #35

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
65 changes: 34 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This package was implemented using [tape](https://www.npmjs.com/package/tape) as
- [💡 `process.mainArgs` Proposal](#-processmainargs-proposal)
- [Implementation:](#implementation)
- [💡 `util.parseArgs(argv)` Proposal](#-utilparseargsargv-proposal)
- [📃 Examples w/ Output](#-examples-w-output)
- [📃 Examples](#-examples)
- [F.A.Qs](#faqs)

----
Expand Down Expand Up @@ -90,54 +90,57 @@ into an `Array`

----

## 📃 Examples w/ Output
## 📃 Examples

```js
const { parseArgs } = require('util')
const { parseArgs } = require('@pkgjs/parseargs');
```

```js
// unconfigured
const argv = ['-f', '--foo=a', '--bar', 'b']
const options = {}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { f: true, bar: true }
values // { foo: 'a' }
positionals // ['b']
const argv = ['-f', '--foo=a', '--bar', 'b'];
const options = {};
const { flags, values, positionals } = parseArgs(argv, options);
// flags = { f: true, bar: true }
// values = { foo: 'a' }
// positionals = ['b']
```

```js
// withValue
const argv = ['-f', '--foo=a', '--bar', 'b']
const argv = ['-f', '--foo=a', '--bar', 'b'];
const options = {
withValue: ['bar']
}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { f: true }
values // { foo: 'a', bar: 'b' }
positionals // []
withValue: ['bar']
};
const { flags, values, positionals } = parseArgs(argv, options);
// flags = { f: true }
// values = { foo: 'a', bar: 'b' }
// positionals = []
```

```js
// withValue & multiples
const argv = ['-f', '--foo=a', '--foo', 'b']
const argv = ['-f', '--foo=a', '--foo', 'b'];
const options = {
withValue: ['foo'],
multiples: ['foo']
}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { f: true }
values // { foo: ['a', 'b'] }
positionals // []
withValue: ['foo'],
multiples: ['foo']
};
const { flags, values, positionals } = parseArgs(argv, options);
// flags = { f: true }
// values = { foo: ['a', 'b'] }
// positionals = []
```

```js
// shorts
const argv = ['-f', 'b']
const argv = ['-f', 'b'];
const options = {
short: { f: 'foo' }
}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { foo: true }
values // {}
positionals // ['b']
short: { f: 'foo' }
};
const { flags, values, positionals } = parseArgs(argv, options);
// flags = { foo: true }
// values = {}
// positionals = ['b']
```

### F.A.Qs
Expand Down