mirror of
https://github.com/morhetz/gruvbox.git
synced 2025-11-16 23:33:38 -05:00
chore(package): re-init package with commitizen and standard-release
This commit is contained in:
65
node_modules/listr-update-renderer/readme.md
generated
vendored
Normal file
65
node_modules/listr-update-renderer/readme.md
generated
vendored
Normal file
@@ -0,0 +1,65 @@
|
||||
# listr-update-renderer [](https://travis-ci.org/SamVerschueren/listr-update-renderer)
|
||||
|
||||
> [Listr](https://github.com/SamVerschueren/listr) update renderer
|
||||
|
||||
<img src="screenshot.gif" />
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
$ npm install --save listr-update-renderer
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const UpdaterRenderer = require('listr-update-renderer');
|
||||
const Listr = require('listr');
|
||||
|
||||
const list = new Listr([
|
||||
{
|
||||
title: 'foo',
|
||||
task: () => Promise.resolve('bar')
|
||||
}
|
||||
], {
|
||||
renderer: UpdaterRenderer,
|
||||
collapse: false
|
||||
});
|
||||
|
||||
list.run();
|
||||
```
|
||||
|
||||
> Note: This is the default renderer for [Listr](https://github.com/SamVerschueren/listr) and doesn't need to be specified.
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
These options should be provided in the [Listr](https://github.com/SamVerschueren/listr) options object.
|
||||
|
||||
### showSubtasks
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `true`
|
||||
|
||||
Set to `false` if you want to disable the rendering of the subtasks. Subtasks will be rendered if an error occurred in one of them.
|
||||
|
||||
### collapse
|
||||
|
||||
Type: `boolean`<br>
|
||||
Default: `true`
|
||||
|
||||
Set to `false` if you don't want subtasks to be hidden after the main task succeed.
|
||||
|
||||
|
||||
## Related
|
||||
|
||||
- [listr](https://github.com/SamVerschueren/listr) - Terminal task list
|
||||
- [listr-verbose-renderer](https://github.com/SamVerschueren/listr-verbose-renderer) - Listr verbose renderer
|
||||
- [listr-silent-renderer](https://github.com/SamVerschueren/listr-silent-renderer) - Suppress Listr rendering output
|
||||
|
||||
|
||||
## License
|
||||
|
||||
MIT © [Sam Verschueren](https://github.com/SamVerschueren)
|
||||
Reference in New Issue
Block a user