♻️ Use a pure function when stripping ANSI codes

src/utils/print.js

@@ -19,20 +19,17 @@ import config from './config';
 import { shouldUseJsonOutput, shouldUsePrettyOutput } from './helpers';
 import tablify from './tablify';
 
-const disableAnsi = (result) => {
-	// eslint-disable-next-line no-param-reassign
-	Object.keys(result).forEach((key) => { result[key] = stripAnsi(result[key]); });
-	return result;
-};
+const removeAnsi = result => Object.entries(result)
+	.reduce(
+		(strippedResult, [key, value]) =>
+			Object.assign({}, strippedResult, { [key]: stripAnsi(value) })
+		, {},
+	);
 
 export const printResult = (vorpal, options = {}) => (result) => {
 	const useJsonOutput = shouldUseJsonOutput(config, options);
 	const prettifyOutput = shouldUsePrettyOutput(config, options);
-	let resultToPrint = result;
-
-	if (useJsonOutput) {
-		resultToPrint = disableAnsi(result);
-	}
+	const resultToPrint = useJsonOutput ? removeAnsi(result) : result;
 
 	const output = useJsonOutput
 		? JSON.stringify(resultToPrint, null, prettifyOutput ? '\t' : null)

test/specs/utils/print.js

@@ -41,17 +41,17 @@ describe('print utils', () => {
 								When('the result is printed', when.theResultIsPrinted, () => {
 									Then('shouldUseJsonOutput should be called with the config and the options', then.shouldUseJsonOutputShouldBeCalledWithTheConfigAndTheOptions);
 									Then('shouldUsePrettyOutput should be called with the config and the options', then.shouldUsePrettyOutputShouldBeCalledWithTheConfigAndTheOptions);
-									Then('the result should be returned', then.theResultShouldBeReturned);
-									Then('JSON output should be logged', then.jSONOutputShouldBeLogged);
+									Then('the result stripped of ANSI codes should be returned', then.theResultStrippedOfANSICodesShouldBeReturned);
+									Then('JSON output should be logged without ANSI codes', then.jSONOutputShouldBeLoggedWithoutANSICodes);
 								});
 							});
 							Given('the options object has key "pretty" set to boolean true', given.theOptionsObjectHasKeySetToBoolean, () => {
 								Given('output should be pretty', given.outputShouldBePretty, () => {
 									When('the result is printed', when.theResultIsPrinted, () => {
 										Then('shouldUseJsonOutput should be called with the config and the options', then.shouldUseJsonOutputShouldBeCalledWithTheConfigAndTheOptions);
 										Then('shouldUsePrettyOutput should be called with the config and the options', then.shouldUsePrettyOutputShouldBeCalledWithTheConfigAndTheOptions);
-										Then('the result should be returned', then.theResultShouldBeReturned);
-										Then('pretty JSON output should be logged', then.prettyJSONOutputShouldBeLogged);
+										Then('the result stripped of ANSI codes should be returned', then.theResultStrippedOfANSICodesShouldBeReturned);
+										Then('pretty JSON output should be logged without ANSI codes', then.prettyJSONOutputShouldBeLoggedWithoutANSICodes);
 									});
 								});
 							});
@@ -65,8 +65,8 @@ describe('print utils', () => {
 								When('the result is printed', when.theResultIsPrinted, () => {
 									Then('shouldUseJsonOutput should be called with the config and the options', then.shouldUseJsonOutputShouldBeCalledWithTheConfigAndTheOptions);
 									Then('shouldUsePrettyOutput should be called with the config and the options', then.shouldUsePrettyOutputShouldBeCalledWithTheConfigAndTheOptions);
-									Then('the result should be returned', then.theResultShouldBeReturned);
-									Then('pretty JSON output should be logged', then.prettyJSONOutputShouldBeLogged);
+									Then('the result stripped of ANSI codes should be returned', then.theResultStrippedOfANSICodesShouldBeReturned);
+									Then('pretty JSON output should be logged without ANSI codes', then.prettyJSONOutputShouldBeLoggedWithoutANSICodes);
 								});
 							});
 						});
@@ -77,8 +77,8 @@ describe('print utils', () => {
 								When('the result is printed', when.theResultIsPrinted, () => {
 									Then('shouldUseJsonOutput should be called with the config and the options', then.shouldUseJsonOutputShouldBeCalledWithTheConfigAndTheOptions);
 									Then('shouldUsePrettyOutput should be called with the config and the options', then.shouldUsePrettyOutputShouldBeCalledWithTheConfigAndTheOptions);
-									Then('the result should be returned', then.theResultShouldBeReturned);
-									Then('JSON output should be logged', then.jSONOutputShouldBeLogged);
+									Then('the result stripped of ANSI codes should be returned', then.theResultStrippedOfANSICodesShouldBeReturned);
+									Then('JSON output should be logged without ANSI codes', then.jSONOutputShouldBeLoggedWithoutANSICodes);
 								});
 							});
 						});

test/steps/printing/1_given.js

@@ -19,7 +19,8 @@ import {
 } from '../../../src/utils/helpers';
 
 export function thereIsAResultToPrint() {
-	this.test.ctx.result = { lisk: 'JS' };
+	this.test.ctx.result = { lisk: 'Some prefix: \u001B[4mJS\u001B[0m' };
+	this.test.ctx.resultWithoutANSICodes = { lisk: 'Some prefix: JS' };
 }
 
 export function jsonShouldBePrinted() {

test/steps/printing/3_then.js

@@ -73,12 +73,24 @@ export function prettyJSONOutputShouldBeLogged() {
 	return (vorpal.activeCommand.log).should.be.calledWithExactly(prettyJsonOutput);
 }
 
+export function prettyJSONOutputShouldBeLoggedWithoutANSICodes() {
+	const { resultWithoutANSICodes, vorpal } = this.test.ctx;
+	const prettyJsonOutput = JSON.stringify(resultWithoutANSICodes, null, '\t');
+	return (vorpal.activeCommand.log).should.be.calledWithExactly(prettyJsonOutput);
+}
+
 export function jSONOutputShouldBeLogged() {
 	const { result, vorpal } = this.test.ctx;
 	const jsonOutput = JSON.stringify(result);
 	return (vorpal.activeCommand.log).should.be.calledWithExactly(jsonOutput);
 }
 
+export function jSONOutputShouldBeLoggedWithoutANSICodes() {
+	const { resultWithoutANSICodes, vorpal } = this.test.ctx;
+	const jsonOutput = JSON.stringify(resultWithoutANSICodes);
+	return (vorpal.activeCommand.log).should.be.calledWithExactly(jsonOutput);
+}
+
 export function shouldUseJsonOutputShouldBeCalledWithTheConfigAndAnEmptyOptionsObject() {
 	const { config } = this.test.ctx;
 	return (shouldUseJsonOutput).should.be.calledWithExactly(config, {});

test/steps/queries/3_then.js

@@ -13,6 +13,7 @@
  * Removal or modification of this copyright notice is prohibited.
  *
  */
+import stripAnsi from 'strip-ansi';
 import {
 	getFirstQuotedString,
 } from '../utils';
@@ -43,3 +44,14 @@ export function theResultShouldBeReturned() {
 	const { returnValue, result } = this.test.ctx;
 	return (returnValue).should.equal(result);
 }
+
+export function theResultStrippedOfANSICodesShouldBeReturned() {
+	const { returnValue, result } = this.test.ctx;
+	const resultWithoutANSICodes = Object.entries(result)
+		.reduce(
+			(strippedResult, [key, value]) =>
+				Object.assign({}, strippedResult, { [key]: stripAnsi(value) })
+			, {},
+		);
+	return (returnValue).should.eql(resultWithoutANSICodes);
+}