73 lines
1.7 KiB
Markdown
73 lines
1.7 KiB
Markdown
|
# 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.
|
||
|
|
|
||
|
|
### clearOutput
|
||
|
|
|
||
|
|
Type: `boolean`<br>
|
||
|
|
Default: `false`
|
||
|
|
|
||
|
|
Clear the output when all the tasks are executed succesfully.
|
||
|
|
|
||
|
|
|
||
|
|
## 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)
|