refactor(format): use new report format and output as string

Author: byCedric

@commitlint/format/package.json

@@ -68,6 +68,7 @@
     "concurrently": "3.5.1",
     "cross-env": "5.1.1",
     "lodash.includes": "4.3.0",
+    "lodash.merge": "4.3.0",
     "rimraf": "2.6.1",
     "xo": "0.20.3"
   },

@commitlint/format/src/index.js

@@ -1,15 +1,50 @@
 import chalk from 'chalk';
+import merge from 'lodash.merge';
 
 const DEFAULT_SIGNS = [' ', '⚠', '✖'];
 const DEFAULT_COLORS = ['white', 'yellow', 'red'];
 
-export default function format(report = {}, options = {}) {
+export default function format(report = {}, flags = {}, options = {}) {
+	const opts = merge({color: flags.color}, options);
+	const {results = []} = report;
+
+	if (results.length > 0) {
+		return results
+			.map(
+				result =>
+					`${formatInput(result, opts)}${formatResult(result, opts).join('\n')}`
+			)
+			.join('\n');
+	}
+
+	// Output a summary when nothing is found
+	return formatResult({}, opts).join('\n');
+}
+
+function formatInput(result = {}, options = {}) {
+	const {color: enabled = true} = options;
+	const {errors = [], input = ''} = result;
+
+	if (!input) {
+		return '';
+	}
+
+	const sign = '⧗';
+	const decoration = enabled ? chalk.gray(sign) : sign;
+	const commitText = errors.length > 0 ? `\n${input}\n` : input.split('\n')[0];
+
+	const decoratedInput = enabled ? chalk.bold(commitText) : commitText;
+
+	return `\n${decoration}   input: ${decoratedInput}\n`;
+}
+
+function formatResult(result = {}, options = {}) {
 	const {
 		signs = DEFAULT_SIGNS,
 		colors = DEFAULT_COLORS,
 		color: enabled = true
 	} = options;
-	const {errors = [], warnings = []} = report;
+	const {errors = [], warnings = []} = result;
 
 	const problems = [...errors, ...warnings].map(problem => {
 		const sign = signs[problem.level] || '';
@@ -31,16 +66,16 @@ export default function format(report = {}, options = {}) {
 	return [...problems, enabled ? chalk.bold(summary) : summary];
 }
 
-function selectSign(report) {
-	if (report.errors.length > 0) {
+function selectSign(result) {
+	if (result.errors.length > 0) {
 		return '✖';
 	}
-	return report.warnings.length ? '⚠' : '✔';
+	return result.warnings.length ? '⚠' : '✔';
 }
 
-function selectColor(report) {
-	if (report.errors.length > 0) {
+function selectColor(result) {
+	if (result.errors.length > 0) {
 		return 'red';
 	}
-	return report.warnings.length ? 'yellow' : 'green';
+	return result.warnings.length ? 'yellow' : 'green';
 }

@commitlint/format/src/index.test.js

@@ -7,91 +7,138 @@ const ok = chalk.bold(`${chalk.green('✔')}   found 0 problems, 0 warnings`);
 
 test('does nothing without arguments', t => {
 	const actual = format();
-	t.deepEqual(actual, [ok]);
+	t.deepEqual(actual, ok);
+});
+
+test('does nothing without report results', t => {
+	const actual = format({results: []});
+	t.deepEqual(actual, ok);
 });
 
 test('does nothing without .errors and .warnings', t => {
-	const actual = format({});
-	t.deepEqual(actual, [ok]);
+	const actual = format({results: [{}]});
+	t.deepEqual(actual, ok);
 });
 
 test('returns empty summary of problems for empty .errors and .warnings', t => {
-	const [msg] = format({
-		errors: [],
-		warnings: []
+	const actual = format({
+		results: [
+			{
+				errors: [],
+				warnings: []
+			}
+		]
 	});
 
-	t.true(msg.includes('0 problems, 0 warnings'));
+	t.true(actual.includes('0 problems, 0 warnings'));
 });
 
 test('returns a correct of empty .errors and .warnings', t => {
-	const [err, prob, msg] = format({
-		errors: [
+	const actualError = format({
+		results: [
 			{
-				level: 2,
-				name: 'error-name',
-				message: 'There was an error'
+				errors: [
+					{
+						level: 2,
+						name: 'error-name',
+						message: 'There was an error'
+					}
+				]
 			}
-		],
-		warnings: [
+		]
+	});
+
+	const actualWarning = format({
+		results: [
 			{
-				level: 1,
-				name: 'warning-name',
-				message: 'There was a problem'
+				warnings: [
+					{
+						level: 1,
+						name: 'warning-name',
+						message: 'There was a problem'
+					}
+				]
 			}
 		]
 	});
 
-	t.true(includes(err, 'There was an error'));
-	t.true(includes(prob, 'There was a problem'));
-	t.true(includes(msg, '1 problems, 1 warnings'));
+	t.true(includes(actualError, 'There was an error'));
+	t.true(includes(actualError, '1 problems, 0 warnings'));
+	t.true(includes(actualWarning, 'There was a problem'));
+	t.true(includes(actualWarning, '0 problems, 1 warnings'));
 });
 
 test('uses appropriate signs by default', t => {
-	const [err, warn] = format({
-		errors: [
+	const actualError = format({
+		results: [
 			{
-				level: 2,
-				name: 'error-name',
-				message: 'There was an error'
+				errors: [
+					{
+						level: 2,
+						name: 'error-name',
+						message: 'There was an error'
+					}
+				]
 			}
-		],
-		warnings: [
+		]
+	});
+
+	const actualWarning = format({
+		results: [
 			{
-				level: 1,
-				name: 'warning-name',
-				message: 'There was a problem'
+				warnings: [
+					{
+						level: 1,
+						name: 'warning-name',
+						message: 'There was a problem'
+					}
+				]
 			}
 		]
 	});
 
-	t.true(includes(err, '✖'));
-	t.true(includes(warn, '⚠'));
+	t.true(includes(actualError, '✖'));
+	t.true(includes(actualWarning, '⚠'));
 });
 
 test('uses signs as configured', t => {
-	const [err, warn] = format(
+	const options = {signs: ['HNT', 'WRN', 'ERR']};
+	const actualError = format(
 		{
-			errors: [
+			results: [
 				{
-					level: 2,
-					name: 'error-name',
-					message: 'There was an error'
+					errors: [
+						{
+							level: 2,
+							name: 'error-name',
+							message: 'There was an error'
+						}
+					]
 				}
-			],
-			warnings: [
+			]
+		},
+		{},
+		options
+	);
+
+	const actualWarning = format(
+		{
+			results: [
 				{
-					level: 1,
-					name: 'warning-name',
-					message: 'There was a problem'
+					warnings: [
+						{
+							level: 1,
+							name: 'warning-name',
+							message: 'There was a problem'
+						}
+					]
 				}
 			]
 		},
-		{
-			signs: ['HNT', 'WRN', 'ERR']
-		}
+		{},
+		options
 	);
 
-	t.true(includes(err, 'ERR'));
-	t.true(includes(warn, 'WRN'));
+	t.true(includes(actualError, 'ERR'));
+	t.true(includes(actualWarning, 'WRN'));
 });