Skip to content

Add option to disable error message on process exit #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eykrehbein wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add option to disable error message on process exit #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81a2e77
Add option to disable error message on process exit
eykrehbein Apr 13, 2019
d75232f
Edit README. Add errorOnExit explanation
eykrehbein Apr 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 31 additions & 15 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ class Listr {
constructor(tasks, opts) {
if (tasks && !Array.isArray(tasks) && typeof tasks === 'object') {
if (typeof tasks.title === 'string' && typeof tasks.task === 'function') {
throw new TypeError('Expected an array of tasks or an options object, got a task object');
throw new TypeError(
'Expected an array of tasks or an options object, got a task object'
);
}

opts = tasks;
Expand All @@ -28,12 +30,16 @@ class Listr {
throw new TypeError('Expected an array of tasks');
}

this._options = Object.assign({
showSubtasks: true,
concurrent: false,
renderer: 'default',
nonTTYRenderer: 'verbose'
}, opts);
this._options = Object.assign(
{
showSubtasks: true,
errorOnExit: true,
concurrent: false,
renderer: 'default',
nonTTYRenderer: 'verbose'
},
opts
);
this._tasks = [];

this.concurrency = 1;
Expand All @@ -43,9 +49,13 @@ class Listr {
this.concurrency = this._options.concurrent;
}

this._RendererClass = renderer.getRenderer(this._options.renderer, this._options.nonTTYRenderer);
this._RendererClass = renderer.getRenderer(
this._options.renderer,
this._options.nonTTYRenderer
);

this.exitOnError = this._options.exitOnError;
this.errorOnExit = this._options.errorOnExit;

this.add(tasks || []);
}
Expand Down Expand Up @@ -91,17 +101,23 @@ class Listr {

this._checkAll(context);

const tasks = pMap(this._tasks, task => {
this._checkAll(context);
return runTask(task, context, errors);
}, {concurrency: this.concurrency});
const tasks = pMap(
this._tasks,
task => {
this._checkAll(context);
return runTask(task, context, errors);
},
{ concurrency: this.concurrency }
);

return tasks
.then(() => {
if (errors.length > 0) {
const err = new ListrError('Something went wrong');
err.errors = errors;
throw err;
if (this.errorOnExit === true) {
const err = new ListrError('Something went wrong');
err.errors = errors;
throw err;
}
}

this._renderer.end();
Expand Down
7 changes: 7 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,13 @@ Default: `true`

Set to `false` if you don't want to stop the execution of other tasks when one or more tasks fail.

##### errorOnExit

Type: `boolean`<br>
Default: `true`

Set to `false` if you don't want an error to be logged at the end of all tasks, if any of them has throwns an error

##### renderer

Type: `string` `object`<br>
Expand Down