fix: ignore empty commit messages #615 (#676)

* fix: ignore empty commit messages #615 bypass rules for completely empty commit messages (only of blank lines/comments in message) * fix: skip parsing for empty strings * style: apply autoformatting Co-authored-by: Mario Nebl <[email protected]>
conventional-changelog · Feb 18, 2020 · c3eb1a7 · c3eb1a7
1 parent 8b394c9
commit c3eb1a7
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 4 deletions.
diff --git a/@commitlint/lint/src/lint.test.ts b/@commitlint/lint/src/lint.test.ts
@@ -5,9 +5,12 @@ test('throws without params', async () => {
 	await expect(error).rejects.toThrow('Expected a raw commit');
 });
 
-test('throws with empty message', async () => {
-	const error = (lint as any)('');
-	await expect(error).rejects.toThrow('Expected a raw commit');
+test('positive on empty message', async () => {
+	expect(await lint('')).toMatchObject({
+		valid: true,
+		errors: [],
+		warnings: []
+	});
 });
 
 test('positive on stub message and no rule', async () => {

diff --git a/@commitlint/lint/src/lint.ts b/@commitlint/lint/src/lint.ts
@@ -36,7 +36,25 @@ export default async function lint(
 	}
 
 	// Parse the commit message
-	const parsed = await parse(message, undefined, opts.parserOpts);
+	const parsed =
+		message === ''
+			? {header: null, body: null, footer: null}
+			: await parse(message, undefined, opts.parserOpts);
+
+	if (
+		parsed.header === null &&
+		parsed.body === null &&
+		parsed.footer === null
+	) {
+		// Commit is empty, skip
+		return {
+			valid: true,
+			errors: [],
+			warnings: [],
+			input: message
+		};
+	}
+
 	const allRules: Map<string, BaseRule<never, RuleType>> = new Map(
 		Object.entries(defaultRules)
 	);