Skip to content

Commit

Permalink
Tidelift tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
sindresorhus committed May 31, 2019
1 parent 47fe20f commit 54e1f22
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 13 deletions.
1 change: 1 addition & 0 deletions .github/funding.yml
@@ -1,3 +1,4 @@
github: sindresorhus
open_collective: sindresorhus
tidelift: npm/meow
custom: https://sindresorhus.com/donate
3 changes: 3 additions & 0 deletions .github/security.md
@@ -0,0 +1,3 @@
# Security Policy

To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
34 changes: 21 additions & 13 deletions readme.md
Expand Up @@ -67,10 +67,10 @@ foo(cli.input[0], cli.flags);

## API

### meow(helpText, [options])
### meow(helpText, options?)
### meow(options)

Returns an `Object` with:
Returns an `object` with:

- `input` *(Array)* - Non-flag arguments
- `flags` *(Object)* - Flags converted to camelCase excluding aliases
Expand All @@ -88,11 +88,11 @@ Shortcut for the `help` option.

#### options

Type: `Object`
Type: `object`

##### flags

Type: `Object`
Type: `object`

Define argument flags.

Expand All @@ -117,7 +117,7 @@ flags: {

##### description

Type: `string` `boolean`<br>
Type: `string | boolean`<br>
Default: The package.json `"description"` property

Description to show above the help text.
Expand All @@ -126,7 +126,7 @@ Set it to `false` to disable it altogether.

##### help

Type: `string` `boolean`
Type: `string | boolean`

The help text you want shown.

Expand All @@ -136,7 +136,7 @@ The description will be shown above your help text automatically.

##### version

Type: `string` `boolean`<br>
Type: `string | boolean`<br>
Default: The package.json `"version"` property

Set a custom version output.
Expand All @@ -157,16 +157,16 @@ Automatically show the version text when the `--version` flag is present. Useful

##### pkg

Type: `Object`<br>
Type: `object`<br>
Default: Closest package.json upwards

package.json as an `Object`.
package.json as an `object`.

*You most likely don't need this option.*

##### argv

Type: `Array`<br>
Type: `string[]`<br>
Default: `process.argv.slice(2)`

Custom arguments object.
Expand All @@ -182,7 +182,7 @@ By default, the argument `5` in `$ foo 5` becomes a string. Enabling this would

##### booleanDefault

Type: `boolean` `null` `undefined`<br>
Type: `boolean | null | undefined`<br>
Default: `false`

Value of `boolean` flags not defined in `argv`.
Expand Down Expand Up @@ -273,6 +273,14 @@ See [`update-notifier`](https://github.com/yeoman/update-notifier) if you want u
[More useful CLI utilities…](https://github.com/sindresorhus/awesome-nodejs#command-line-utilities)


## License
---

MIT © [Sindre Sorhus](https://sindresorhus.com)
<div align="center">
<b>
<a href="https://tidelift.com/subscription/pkg/npm-meow?utm_source=npm-meow&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
</b>
<br>
<sub>
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
</sub>
</div>

0 comments on commit 54e1f22

Please sign in to comment.