{"_id":"@iamstarkov/listr-update-renderer","_rev":"95188","name":"@iamstarkov/listr-update-renderer","description":"Listr update renderer","dist-tags":{"latest":"0.4.1"},"maintainers":[{"name":"iamstarkov","email":"iamstarkov@gmail.com"}],"time":{"modified":"2021-06-03T10:31:43.000Z","created":"2018-11-06T15:28:55.720Z","0.4.1":"2018-11-06T15:28:55.720Z"},"users":{},"author":{"name":"Sam Verschueren","email":"sam.verschueren@gmail.com","url":"github.com/SamVerschueren"},"repository":{"type":"git","url":"git+https://github.com/SamVerschueren/listr-update-renderer.git"},"versions":{"0.4.1":{"name":"@iamstarkov/listr-update-renderer","version":"0.4.1","description":"Listr update renderer","license":"MIT","repository":{"type":"git","url":"git+https://github.com/SamVerschueren/listr-update-renderer.git"},"author":{"name":"Sam Verschueren","email":"sam.verschueren@gmail.com","url":"github.com/SamVerschueren"},"engines":{"node":">=4"},"scripts":{"test":"xo"},"keywords":["listr","update","renderer","ora","logupdate","rendering"],"dependencies":{"chalk":"^1.1.3","cli-truncate":"^0.2.1","elegant-spinner":"^1.0.1","figures":"^1.7.0","indent-string":"^3.0.0","log-symbols":"^1.0.2","log-update":"^2.3.0","strip-ansi":"^3.0.1"},"devDependencies":{"delay":"^1.3.1","listr":"^0.14.2","xo":"*","zen-observable":"^0.4.0"},"peerDependencies":{"listr":"^0.14.2"},"xo":{"esnext":true},"gitHead":"7f1c7d66e0cdd145c9badfbefd9b02e02c75d685","bugs":{"url":"https://github.com/SamVerschueren/listr-update-renderer/issues"},"homepage":"https://github.com/SamVerschueren/listr-update-renderer#readme","_id":"@iamstarkov/listr-update-renderer@0.4.1","_npmVersion":"6.4.1","_nodeVersion":"10.13.0","_npmUser":{"name":"iamstarkov","email":"iamstarkov@gmail.com"},"dist":{"shasum":"d7c48092a2dcf90fd672b6c8b458649cb350c77e","size":2929,"noattachment":false,"key":"/@iamstarkov/listr-update-renderer/-/@iamstarkov/listr-update-renderer-0.4.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/@iamstarkov/listr-update-renderer/download/@iamstarkov/listr-update-renderer-0.4.1.tgz"},"maintainers":[{"name":"iamstarkov","email":"iamstarkov@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/listr-update-renderer_0.4.1_1541518135521_0.21432554117403968"},"_hasShrinkwrap":false,"publish_time":1541518135720,"_cnpm_publish_time":1541518135720}},"readme":"# listr-update-renderer [![Build Status](https://travis-ci.org/SamVerschueren/listr-update-renderer.svg?branch=master)](https://travis-ci.org/SamVerschueren/listr-update-renderer)\n\n> [Listr](https://github.com/SamVerschueren/listr) update renderer\n\n<img src=\"screenshot.gif\" />\n\n\n## Install\n\n```\n$ npm install --save listr-update-renderer\n```\n\n\n## Usage\n\n```js\nconst UpdaterRenderer = require('listr-update-renderer');\nconst Listr = require('listr');\n\nconst list = new Listr([\n    {\n        title: 'foo',\n        task: () => Promise.resolve('bar')\n    }\n], {\n    renderer: UpdaterRenderer,\n\tcollapse: false\n});\n\nlist.run();\n```\n\n> Note: This is the default renderer for [Listr](https://github.com/SamVerschueren/listr) and doesn't need to be specified.\n\n\n## Options\n\nThese options should be provided in the [Listr](https://github.com/SamVerschueren/listr) options object.\n\n### showSubtasks\n\nType: `boolean`<br>\nDefault: `true`\n\nSet to `false` if you want to disable the rendering of the subtasks. Subtasks will be rendered if an error occurred in one of them.\n\n### collapse\n\nType: `boolean`<br>\nDefault: `true`\n\nSet to `false` if you don't want subtasks to be hidden after the main task succeed.\n\n### clearOutput\n\nType: `boolean`<br>\nDefault: `false`\n\nClear the output when all the tasks are executed succesfully.\n\n\n## Related\n\n- [listr](https://github.com/SamVerschueren/listr) - Terminal task list\n- [listr-verbose-renderer](https://github.com/SamVerschueren/listr-verbose-renderer) - Listr verbose renderer\n- [listr-silent-renderer](https://github.com/SamVerschueren/listr-silent-renderer) - Suppress Listr rendering output\n\n\n## License\n\nMIT © [Sam Verschueren](https://github.com/SamVerschueren)\n","_attachments":{},"homepage":"https://github.com/SamVerschueren/listr-update-renderer#readme","bugs":{"url":"https://github.com/SamVerschueren/listr-update-renderer/issues"},"license":"MIT"}