feat: print commit message when the message is invalid

Duarte Amorim · marionebl · commit 86c34f10344a · 2018-03-20T00:09:38.000+01:00
When using the CLI, if the message is invalid we lose all its content (using a custom message in VIM mode), which might be a little frustrating when we a have a long commit body. This feature prints the full message when there are linting errors. Closes #222
diff --git a/@commitlint/cli/src/cli.js b/@commitlint/cli/src/cli.js
@@ -114,11 +114,13 @@ async function main(options) {
 		messages.map(async message => {
 			const report = await lint(message, loaded.rules, opts);
 			const formatted = format(report, {color: flags.color});
+			const input =
+				report.errors.length > 0
+					? `\n${report.input}\n`
+					: message.split('\n')[0];
 
 			if (!flags.quiet) {
-				console.log(
-					`${fmt.grey('⧗')}   input: ${fmt.bold(message.split('\n')[0])}`
-				);
+				console.log(`${fmt.grey('⧗')}   input: ${fmt.bold(input)}`);
 				console.log(formatted.join('\n'));
 			}
 
diff --git a/@commitlint/cli/src/cli.test.js b/@commitlint/cli/src/cli.test.js
@@ -196,6 +196,25 @@ test('should handle linting with issue prefixes', async t => {
 	t.is(actual.code, 0);
 });
 
+test('should print full commit message when input from stdin fails', async t => {
+	const cwd = await git.bootstrap('fixtures/simple');
+	const input = 'foo: bar\n\nFoo bar bizz buzz.\n\nCloses #123.';
+	const actual = await cli([], {cwd})(input);
+
+	t.true(actual.stdout.includes(input));
+	t.is(actual.code, 1);
+});
+
+test('should not print full commit message when input succeeds', async t => {
+	const cwd = await git.bootstrap('fixtures/empty');
+	const message = 'foo: bar\n\nFoo bar bizz buzz.\n\nCloses #123.';
+	const actual = await cli([], {cwd})(message);
+
+	t.false(actual.stdout.includes(message));
+	t.true(actual.stdout.includes(message.split('\n')[0]));
+	t.is(actual.code, 0);
+});
+
 async function writePkg(payload, options) {
 	const pkgPath = path.join(options.cwd, 'package.json');
 	const pkg = JSON.parse(await sander.readFile(pkgPath));
diff --git a/@commitlint/lint/src/index.js b/@commitlint/lint/src/index.js
@@ -4,13 +4,23 @@ import parse from '@commitlint/parse';
 import implementations from '@commitlint/rules';
 import entries from 'lodash.topairs';
 
+const buildCommitMesage = ({header, body, footer}) => {
+	let message = header;
+
+	message = body ? `${message}\n\n${body}` : message;
+	message = footer ? `${message}\n\n${footer}` : message;
+
+	return message;
+};
+
 export default async (message, rules = {}, opts = {}) => {
 	// Found a wildcard match, skip
 	if (isIgnored(message)) {
 		return {
 			valid: true,
 			errors: [],
-			warnings: []
+			warnings: [],
+			input: message
 		};
 	}
 
@@ -133,6 +143,7 @@ export default async (message, rules = {}, opts = {}) => {
 	return {
 		valid,
 		errors,
-		warnings
+		warnings,
+		input: buildCommitMesage(parsed)
 	};
 };
diff --git a/@commitlint/lint/src/index.test.js b/@commitlint/lint/src/index.test.js
@@ -35,6 +35,7 @@ test('positive on ignored message and broken rule', async t => {
 		'type-empty': [2, 'never']
 	});
 	t.true(actual.valid);
+	t.is(actual.input, 'Revert "some bogus commit"');
 });
 
 test('positive on stub message and opts', async t => {
@@ -182,3 +183,42 @@ test('fails for custom issue prefix', async t => {
 
 	t.false(report.valid);
 });
+
+test('returns original message only with commit header', async t => {
+	const message = 'foo: bar';
+	const report = await lint(message);
+
+	t.is(report.input, message);
+});
+
+test('returns original message with commit header and body', async t => {
+	const message = 'foo: bar/n/nFoo bar bizz buzz.';
+	const report = await lint(message);
+
+	t.is(report.input, message);
+});
+
+test('returns original message with commit header, body and footer', async t => {
+	const message = 'foo: bar/n/nFoo bar bizz buzz./n/nCloses #1';
+	const report = await lint(message);
+
+	t.is(report.input, message);
+});
+
+test('returns original message with commit header, body and footer, parsing comments', async t => {
+	const expected = 'foo: bar/n/nFoo bar bizz buzz./n/nCloses #1';
+	const message = `${expected}\n\n# Some comment to ignore`;
+	const report = await lint(
+		message,
+		{
+			'references-empty': [2, 'never']
+		},
+		{
+			parserOpts: {
+				commentChar: '#'
+			}
+		}
+	);
+
+	t.is(report.input, expected);
+});
diff --git a/yarn.lock b/yarn.lock
