Support changing the spinner while ora is running (#95)

Author: jeetiss

example.js

@@ -20,7 +20,13 @@ setTimeout(() => {
 }, 2000);
 
 setTimeout(() => {
-	spinner.succeed();
+	spinner.indent = 0;
+	spinner.spinner = 'moon';
+	spinner.text = 'Loading with different spinners';
 }, 3000);
 
+setTimeout(() => {
+	spinner.succeed();
+}, 4000);
+
 // $ node example.js nameOfSpinner

index.js

@@ -22,19 +22,13 @@ class Ora {
 			stream: process.stderr
 		}, options);
 
-		const sp = this.options.spinner;
-		this.spinner = typeof sp === 'object' ? sp : (process.platform === 'win32' ? cliSpinners.line : (cliSpinners[sp] || cliSpinners.dots)); // eslint-disable-line no-nested-ternary
-
-		if (this.spinner.frames === undefined) {
-			throw new Error('Spinner must define `frames`');
-		}
+		this.spinner = this.options.spinner;
 
 		this.color = this.options.color;
 		this.hideCursor = this.options.hideCursor !== false;
 		this.interval = this.options.interval || this.spinner.interval || 100;
 		this.stream = this.options.stream;
 		this.id = null;
-		this.frameIndex = 0;
 		this.isEnabled = typeof this.options.isEnabled === 'boolean' ? this.options.isEnabled : ((this.stream && this.stream.isTTY) && !process.env.CI);
 
 		// Set *after* `this.stream`
@@ -55,6 +49,31 @@ class Ora {
 		this._indent = indent;
 	}
 
+	get spinner() {
+		return this._spinner;
+	}
+
+	set spinner(spinner) {
+		this.frameIndex = 0;
+
+		if (typeof spinner === 'object') {
+			if (spinner.frames === undefined) {
+				throw new Error('The given spinner must have a `frames` property');
+			}
+
+			this._spinner = spinner;
+		} else if (process.platform === 'win32') {
+			this._spinner = cliSpinners.line;
+		} else if (spinner === undefined) {
+			// Set default spinner
+			this._spinner = cliSpinners.dots;
+		} else if (cliSpinners[spinner]) {
+			this._spinner = cliSpinners[spinner];
+		} else {
+			throw new Error(`There is no built-in spinner named '${spinner}'. See https://github.com/sindresorhus/cli-spinners/blob/master/spinners.json for a full list.`);
+		}
+	}
+
 	get text() {
 		return this[TEXT];
 	}

readme.md

@@ -188,6 +188,10 @@ Change the text.
 
 Change the spinner color.
 
+#### .spinner
+
+Change the spinner.
+
 #### .indent
 
 Change the spinner indent.

test.js

@@ -236,6 +236,36 @@ test('erases wrapped lines', t => {
 	spinner.stop();
 });
 
+test('reset frameIndex when setting new spinner', async t => {
+	const stream = getPassThroughStream();
+	const output = getStream(stream);
+
+	const spinner = new Ora({
+		stream,
+		isEnabled: true,
+		spinner: {frames: ['foo', 'fooo']}
+	});
+
+	spinner.render();
+	t.is(spinner.frameIndex, 1);
+
+	spinner.spinner = {frames: ['baz']};
+	spinner.render();
+
+	stream.end();
+
+	t.is(spinner.frameIndex, 0);
+	t.regex(stripAnsi(await output), /foo baz/);
+});
+
+test('throw when incorrect spinner', t => {
+	const ora = new Ora();
+
+	t.throws(() => {
+		ora.spinner = 'random-string-12345';
+	}, /no built-in spinner/);
+});
+
 test('indent option', t => {
 	const stream = getPassThroughStream();
 	stream.isTTY = true;