# listr-verbose-renderer

> Listr verbose renderer

Latest version **0.6.0** (published 2019-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install listr-verbose-renderer
pnpm add listr-verbose-renderer
yarn add listr-verbose-renderer
bun add listr-verbose-renderer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2019-10-03 |
| First published | 2016-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 4 |
| Unpacked size | 4.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Sam Verschueren |
| Maintainers | samverschueren |
| Keywords | listr, verbose, renderer, rendering, custom, format |

## Links

- npm: https://www.npmjs.com/package/listr-verbose-renderer
- Repository: https://github.com/SamVerschueren/listr-verbose-renderer
- Homepage: https://github.com/SamVerschueren/listr-verbose-renderer#readme
- Issues: https://github.com/SamVerschueren/listr-verbose-renderer/issues
- npm.io page: https://npm.io/package/listr-verbose-renderer

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [figures](https://npm.io/package/figures.md) ^2.0.0
- [date-fns](https://npm.io/package/date-fns.md) ^2.0.1
- [cli-cursor](https://npm.io/package/cli-cursor.md) ^2.1.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.6.0 (latest) — 2019-10-03
- 0.5.0 — 2018-11-17
- 0.4.1 — 2017-10-25
- 0.4.0 — 2017-02-19
- 0.3.0 — 2017-01-19
- 0.2.1 — 2016-12-06
- 0.2.0 — 2016-11-30
- 0.1.0 — 2016-09-15

## README

# listr-verbose-renderer [![Build Status](https://travis-ci.org/SamVerschueren/listr-verbose-renderer.svg?branch=master)](https://travis-ci.org/SamVerschueren/listr-verbose-renderer)

> [Listr](https://github.com/SamVerschueren/listr) verbose renderer

<img src="screenshot.gif" />


## Install

```
$ npm install --save listr-verbose-renderer
```


## Usage

```js
const VerboseRenderer = require('listr-verbose-renderer');
const Listr = require('listr');

const list = new Listr([
	{
		title: 'foo',
		task: () => Promise.resolve('bar')
	}
], {
	renderer: VerboseRenderer
});

list.run();
```

> Note: This renderer supports non-TTY environments.


## Options

These options should be provided in the [Listr](https://github.com/SamVerschueren/listr) options object.

### dateFormat

Type: `string` `false`<br>
Default: `HH:mm:ss`

Format of the rendered timestamp. Use the [date-fns string format](https://date-fns.org/docs/format). If `false` is passed in, the timestamp will be hidden.


## Related

- [listr](https://github.com/SamVerschueren/listr) - Terminal task list
- [listr-update-renderer](https://github.com/SamVerschueren/listr-update-renderer) - Listr update renderer
- [listr-silent-renderer](https://github.com/SamVerschueren/listr-silent-renderer) - Suppress Listr rendering output


## License

MIT © [Sam Verschueren](https://github.com/SamVerschueren)

---
_Source: https://npm.io/package/listr-verbose-renderer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
