https://github.com/make-github-pseudonymous-again/listr-aggregate-renderer
https://github.com/make-github-pseudonymous-again/listr-aggregate-renderer
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/make-github-pseudonymous-again/listr-aggregate-renderer
- Owner: make-github-pseudonymous-again
- License: mit
- Created: 2017-11-18T11:14:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-18T17:16:47.000Z (over 7 years ago)
- Last Synced: 2025-01-18T15:53:38.255Z (10 months ago)
- Language: JavaScript
- Size: 115 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# listr-update-renderer [](https://travis-ci.org/SamVerschueren/listr-update-renderer)
> [Listr](https://github.com/SamVerschueren/listr) update renderer
## 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`
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`
Default: `true`
Set to `false` if you don't want subtasks to be hidden after the main task succeed.
### clearOutput
Type: `boolean`
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)