added suspending update renderer for task

lib/task.js

@@ -43,12 +43,21 @@ class Task extends Subject {
 		this.title = task.title;
 		this.skip = task.skip || defaultSkipFn;
 		this.task = task.task;
+		this.taskOptions = task.options;
 	}
 
 	get subtasks() {
 		return this._subtasks;
 	}
 
+	shouldSuspendUpdateRenderer() {
+		if (this.isEnabled() && this.isPending() && !this.isCompleted() && this.taskOptions !== undefined) {
+			return this.taskOptions.suspendUpdateRenderer;
+		}
+
+		return false;
+	}
+
 	set state(state) {
 		this._state = state;
 
@@ -160,6 +169,7 @@ class Task extends Subject {
 					if (typeof skipped === 'string') {
 						this.output = skipped;
 					}
+
 					this.state = state.SKIPPED;
 					return;
 				}

package.json

@@ -56,8 +56,10 @@
 		"hook-std": "^1.1.0",
 		"lint-staged": "^8.0.5",
 		"log-symbols": "^2.2.0",
+		"mockery": "^2.1.0",
 		"nyc": "^13.1.0",
 		"pre-commit": "^1.2.2",
+		"sinon": "^7.4.2",
 		"split": "^1.0.1",
 		"xo": "*",
 		"zen-observable": "^0.8.11"

readme.md

@@ -296,6 +296,28 @@ tasks.run();
 ```
 
 
+## Rendering options
+
+By default, [listr-update-renderer](https://github.com/SamVerschueren/listr-update-renderer) is active. This renderer refreshes the state of the tasks every 100 milliseconds. With the option ```suspendUpdateRenderer``` the refresh can be suspended for the time the task is running. After the task is completed, the listr-update-renderer starts again refreshing the state of the tasks.
+
+```js
+const tasks = new Listr([
+	{
+		title: 'Encrypt gpg-file',
+		task: () => execa('gpg', ['-e', 'file']),
+		options: {suspendUpdateRenderer: true}
+	}
+	{
+		title: 'Remove the unencrypted file',
+		task: () => execa('rm', ['file'])
+	}
+]);
+
+tasks.run();
+```
+
+This feature is usefull for tasks with user-input. The user-input is always gobbled up, when the listr-update-renderer is not in suspend-mode.
+
 ## Custom renderers
 
 It's possible to write custom renderers for Listr. A renderer is an ES6 class that accepts the tasks that it should render, and the Listr options object. It has two methods, the `render` method which is called when it should start rendering, and the `end` method. The `end` method is called when all the tasks are completed or if a task failed. If a task failed, the error object is passed in via an argument.

test/concurrent.js

@@ -1,8 +1,8 @@
 import {serial as test} from 'ava';
 import delay from 'delay';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 const tasks = [
 	{

test/enabled.js

@@ -1,7 +1,7 @@
 import {serial as test} from 'ava';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 test('do not run disabled tasks', async t => {
 	const list = new Listr([

test/exit-on-error.js

@@ -1,7 +1,7 @@
 import {serial as test} from 'ava';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 const tasks = [
 	{

test/output.js

@@ -1,8 +1,8 @@
 import test from 'ava';
 import {Observable} from 'rxjs';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 test('output', async t => {
 	const list = new Listr([

test/renderer.js

@@ -1,7 +1,7 @@
 import test from 'ava';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 test('renderer class', async t => {
 	const list = new Listr([

test/skip.js

@@ -1,7 +1,7 @@
 import test from 'ava';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 test('continue execution if skip() returns false or Promise for false', async t => {
 	t.plan(5); // Verify the correct number of tasks were executed

test/stream.js

@@ -2,9 +2,9 @@ import * as fs from 'fs';
 import * as path from 'path';
 import test from 'ava';
 import split from 'split';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 test('output', async t => {
 	const list = new Listr([

test/subtask.js

@@ -1,7 +1,7 @@
 import test from 'ava';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 test('renderer class', async t => {
 	const list = new Listr([

test/suspend.js

@@ -0,0 +1,68 @@
+import {serial as test} from 'ava';
+import sinon from 'sinon';
+
+const mockery = require('mockery');
+
+const logUpdateApi = {
+	main(text) {
+		console.log(text);
+	}
+};
+logUpdateApi.main.clear = function () {
+};
+
+logUpdateApi.main.done = function () {
+};
+
+const mock = sinon.mock(logUpdateApi);
+
+function getTasks() {
+	// Require is necessary at this position, otherwise mockery is not working correctly
+	const Listr = require('..');
+	const tasks = new Listr([
+		{
+			title: 'not suspending task',
+			task: () => {
+				return new Promise(resolve => {
+					setTimeout(() => {
+						resolve('predefined output');
+					}, 150);
+				});
+			}
+		},
+		{
+			title: 'suspending task',
+			task: () => {
+				return new Promise(resolve => {
+					setTimeout(() => {
+						resolve('predefined output');
+					}, 4000);
+				});
+			},
+			options: {suspendUpdateRenderer: true}
+		}
+	]);
+
+	return tasks;
+}
+
+test.before(() => {
+	/* One time for the first task,
+	   one time when both tasks are finished
+	*/
+	mock.expects('main').twice();
+	mockery.registerAllowable('..');
+	mockery.registerMock('log-update', logUpdateApi.main);
+	mockery.enable({useCleanCache: true, warnOnUnregistered: false});
+});
+
+test('should suspend second task', async t => {
+	await getTasks().run();
+
+	t.true(mock.verify());
+});
+
+test.after(() => {
+	mockery.disable();
+	mockery.deregisterAll();
+});

test/task-wrapper.js

@@ -1,7 +1,7 @@
 import {serial as test} from 'ava';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 test('changing the title during task execution', async t => {
 	const list = new Listr([

test/tty.js

@@ -1,9 +1,9 @@
 import test from 'ava';
 import {Observable} from 'rxjs';
-import Listr from '..';
 import SimpleRenderer from './fixtures/simple-renderer';
 import TTYRenderer from './fixtures/tty-renderer';
 import {testOutput} from './fixtures/utils';
+import Listr from '..';
 
 const ttyOutput = [
 	'foo [started]',

test/utils.js

@@ -1,8 +1,8 @@
 import test from 'ava';
 import {Observable as RxObservable} from 'rxjs';
 import ZenObservable from 'zen-observable';
-import Listr from '..';
 import {isListr, isObservable} from '../lib/utils';
+import Listr from '..';
 
 test('isListr', t => {
 	t.false(isListr(null));