Add succeed ✔, fail ✖ and stopAndPersist 🦄 (#20)

Author: matheuss

example.js

@@ -13,4 +13,8 @@ setTimeout(() => {
 	spinner.text = 'Loading rainbows';
 }, 1000);
 
+setTimeout(() => {
+	spinner.succeed();
+}, 2000);
+
 // $ node example.js nameOfSpinner

index.js

@@ -2,6 +2,7 @@
 const chalk = require('chalk');
 const cliCursor = require('cli-cursor');
 const cliSpinners = require('cli-spinners');
+const logSymbols = require('log-symbols');
 
 class Ora {
 	constructor(options) {
@@ -82,6 +83,18 @@ class Ora {
 		this.clear();
 		cliCursor.show();
 
+		return this;
+	}
+	succeed() {
+		return this.stopAndPersist(logSymbols.success);
+	}
+	fail() {
+		return this.stopAndPersist(logSymbols.error);
+	}
+	stopAndPersist(symbol) {
+		this.stop();
+		this.stream.write(`${symbol || ' '} ${this.text}\n`);
+
 		return this;
 	}
 }

package.json

@@ -37,7 +37,8 @@
   "dependencies": {
     "chalk": "^1.1.1",
     "cli-cursor": "^1.0.2",
-    "cli-spinners": "^0.1.2"
+    "cli-spinners": "^0.1.2",
+    "log-symbols": "^1.0.2"
   },
   "devDependencies": {
     "ava": "*",

readme.md

@@ -103,6 +103,20 @@ Start the spinner. Returns the instance.
 
 Stop and clear the spinner. Returns the instance.
 
+### .succeed()
+
+Stop the spinner, change it to a green `✔` and persist the `text`. Returns the instance. See the below GIF below.
+
+### .fail()
+
+Stop the spinner, change it to a red `✖` and persist the `text`. Returns the instance. See the below GIF below.
+
+### .stopAndPersist([symbol])
+
+Stop the spinner, change it to `symbol` (or `' '` if `symbol` is not provided) and persist the `text`. Returns the instance. See the below GIF below.
+
+<img src="screenshot-2.gif" width="480">
+
 #### .clear()
 
 Clear the spinner. Returns the instance.

screenshot-2.gif

@@ -1,6 +1,7 @@
 import {PassThrough as PassThroughStream} from 'stream';
 import getStream from 'get-stream';
 import test from 'ava';
+import {stripColor} from 'chalk';
 import Ora from './';
 
 const spinnerChar = process.platform === 'win32' ? '-' : '⠋';
@@ -78,3 +79,79 @@ test('chain call to `.start()` with constructor', t => {
 	t.truthy(spinner.id);
 	t.true(spinner.enabled);
 });
+
+test('succeed', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.succeed();
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(stripColor(output), /✔|√ foo/);
+});
+
+test('fail', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.fail();
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(stripColor(output), /✖|× foo/);
+});
+
+test('stopAndPersist', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.stopAndPersist('@');
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(output, /@ foo/);
+});
+
+test('stopAndPersist with no argument', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.stopAndPersist(' ');
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(output, /\s foo/);
+});