Add ability to change text when stopping and persisting

index.js

@@ -85,15 +85,25 @@ class Ora {
 
 		return this;
 	}
-	succeed() {
-		return this.stopAndPersist(logSymbols.success);
+	succeed(text) {
+		return this.stopAndPersist({symbol: logSymbols.success, text});
 	}
-	fail() {
-		return this.stopAndPersist(logSymbols.error);
+	fail(text) {
+		return this.stopAndPersist({symbol: logSymbols.error, text});
 	}
-	stopAndPersist(symbol) {
+	stopAndPersist(options) {
+		// Legacy argument
+		// TODO: Deprecate sometime in the future
+		if (typeof options === 'string') {
+			options = {
+				symbol: options
+			};
+		}
+
+		options = options || {};
+
 		this.stop();
-		this.stream.write(`${symbol || ' '} ${this.text}\n`);
+		this.stream.write(`${options.symbol || ' '} ${options.text || this.text}\n`);
 
 		return this;
 	}

readme.md

@@ -102,17 +102,35 @@ Start the spinner. Returns the instance.
 
 Stop and clear the spinner. Returns the instance.
 
-### .succeed()
+#### .succeed([text])
 
-Stop the spinner, change it to a green `✔` and persist the `text`. Returns the instance. See the GIF below.
+Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
 
-### .fail()
+#### .fail([text])
 
-Stop the spinner, change it to a red `✖` and persist the `text`. Returns the instance. See the GIF below.
+Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
 
-### .stopAndPersist([symbol])
+#### .stopAndPersist([options])
 
-Stop the spinner, change it to `symbol` (or `' '` if `symbol` is not provided) and persist the `text`. Returns the instance. See the GIF below.
+Stop the spinner and change the symbol or text. Returns the instance. See the GIF below.
+
+##### options
+
+Type: `Object`
+
+###### symbol
+
+Type: `string`<br>
+Default: `' '`
+
+Symbol to replace the spinner with.
+
+###### text
+
+Type: `string`<br>
+Default: Current text
+
+Text to be persisted.
 
 <img src="screenshot-2.gif" width="480">
 

test.js

@@ -98,6 +98,25 @@ test('succeed', async t => {
 	t.regex(stripColor(output), /✔|√ foo/);
 });
 
+test('succeed with new text', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.succeed('fooed');
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(stripColor(output), /✔|√ fooed/);
+});
+
 test('fail', async t => {
 	const stream = getPassThroughStream();
 
@@ -117,6 +136,25 @@ test('fail', async t => {
 	t.regex(stripColor(output), /✖|× foo/);
 });
 
+test('fail with new text', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.fail('failed to foo');
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(stripColor(output), /✖|× failed to foo/);
+});
+
 test('stopAndPersist', async t => {
 	const stream = getPassThroughStream();
 
@@ -155,6 +193,44 @@ test('stopAndPersist with no argument', async t => {
 	t.regex(output, /\s foo/);
 });
 
+test('stopAndPersist with new text', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.stopAndPersist({text: 'all done'});
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(output, /\s all done/);
+});
+
+test('stopAndPersist with new symbol and text', async t => {
+	const stream = getPassThroughStream();
+
+	const spinner = new Ora({
+		stream,
+		text: 'foo',
+		color: false,
+		enabled: true
+	});
+
+	spinner.start();
+	spinner.stopAndPersist({symbol: '@', text: 'all done'});
+
+	stream.end();
+	const output = await getStream(stream);
+
+	t.regex(output, /@ all done/);
+});
+
 test('promise resolves', async t => {
 	const stream = getPassThroughStream();
 	const resolves = Promise.resolve(1);