fix: prevent false positives for footer-leading-blank (#33)

* test: add test cases for footer-leading-blank

* fix: succeed footer-leading-blank if no footer is found

* fix: sanitize check for leading blank line before footer

Author: marionebl

packages/conventional-changelog-lint/source/index.js

@@ -1,11 +1,11 @@
-import {sync as parse} from 'conventional-commits-parser';
 import {merge} from 'lodash';
 
 import ruleFunctions from './rules';
 import format from './library/format';
 import getConfiguration from './library/get-configuration';
 import getMessages from './library/get-messages';
 import getPreset from './library/get-preset';
+import parse from './library/parse';
 
 export {format, getConfiguration, getMessages, getPreset};
 
@@ -21,10 +21,7 @@ export default async (message, options = {}) => {
 	} = options;
 
 	// parse the commit message
-	const parsed = merge(
-		{raw: message},
-		parse(message, parserOptions)
-	);
+	const parsed = parse(message);
 
 	// wildcard matches skip the linting
 	const bails = Object.entries(wildcards)

packages/conventional-changelog-lint/source/library/parse.js

@@ -0,0 +1,9 @@
+import {sync} from 'conventional-commits-parser';
+
+export default parse;
+
+function parse(message, options) {
+	const parsed = sync(message, options);
+	parsed.raw = message;
+	return parsed;
+}

packages/conventional-changelog-lint/source/rules/footer-leading-blank.js

@@ -1,14 +1,20 @@
 export default (parsed, when) => {
+	// flunk if no footer is found
+	if (!parsed.footer) {
+		return [true];
+	}
+
 	const negated = when === 'never';
+
 	// get complete body split into lines
-	const lines = (parsed.raw || '').split('\n').slice(2);
-	// check if the first line of body (if any) is empty
-	const leadingBlank =
-		lines.length > 0 ?
-		lines[0].length === 0 :
-		true;
+	const lines = (parsed.raw || '').split(/\r|\n/).slice(2);
+	const [leading] = lines;
+
+	// check if the first line of body is empty
+	const succeeds = leading === '';
+
 	return [
-		negated ? !leadingBlank : leadingBlank,
+		negated ? !succeeds : succeeds,
 		[
 			'footer',
 			negated ? 'may not' : 'must',

packages/conventional-changelog-lint/test/rules/footer-leading-blank.js

@@ -0,0 +1,109 @@
+import test from 'ava';
+import parse from '../../source/library/parse';
+import footerLeadingBlank from '../../source/rules/footer-leading-blank';
+
+const messages = {
+	simple: 'chore: subject',
+	body: 'chore: subject\nbody',
+	trailing: 'chore: subject\nbody\n\n',
+	without: 'chore: subject\nbody\nBREAKING CHANGE: something important',
+	with: 'chore: subject\nbody\n\nBREAKING CHANGE: something important'
+};
+
+const parsed = {
+	simple: parse(messages.simple),
+	body: parse(messages.body),
+	trailing: parse(messages.trailing),
+	without: parse(messages.without),
+	with: parse(messages.with)
+};
+
+test('footer-leading-blank with simple message should succeed for empty keyword', t => {
+	const [actual] = footerLeadingBlank(parsed.simple);
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with simple message should succeed for "never"', t => {
+	const [actual] = footerLeadingBlank(parsed.simple, 'never');
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with simple message should succeed for "always"', t => {
+	const [actual] = footerLeadingBlank(parsed.simple, 'always');
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with body message should succeed for empty keyword', t => {
+	const [actual] = footerLeadingBlank(parsed.body);
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with body message should succeed for "never"', t => {
+	const [actual] = footerLeadingBlank(parsed.body, 'never');
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with body message should succeed for "always"', t => {
+	const [actual] = footerLeadingBlank(parsed.body, 'always');
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with trailing message should succeed for empty keyword', t => {
+	const [actual] = footerLeadingBlank(parsed.trailing);
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with trailing message should succeed for "never"', t => {
+	const [actual] = footerLeadingBlank(parsed.trailing, 'never');
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with trailing message should succeed for "always"', t => {
+	const [actual] = footerLeadingBlank(parsed.trailing, 'always');
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank without blank line before footer should fail for empty keyword', t => {
+	const [actual] = footerLeadingBlank(parsed.without);
+	const expected = false;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank without blank line before footer should succeed for "never"', t => {
+	const [actual] = footerLeadingBlank(parsed.without, 'never');
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank without blank line before footer should fail for "always"', t => {
+	const [actual] = footerLeadingBlank(parsed.without, 'always');
+	const expected = false;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with blank line before footer should succeed for empty keyword', t => {
+	const [actual] = footerLeadingBlank(parsed.with);
+	const expected = true;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with blank line before footer should fail for "never"', t => {
+	const [actual] = footerLeadingBlank(parsed.with, 'never');
+	const expected = false;
+	t.is(actual, expected);
+});
+
+test('footer-leading-blank with blank line before footer should succeed for "always"', t => {
+	const [actual] = footerLeadingBlank(parsed.with, 'always');
+	const expected = true;
+	t.is(actual, expected);
+});

packages/conventional-changelog-lint/test/rules/scope-empty.js

@@ -1,5 +1,5 @@
 import test from 'ava';
-import {sync as parse} from 'conventional-commits-parser';
+import parse from '../../source/library/parse';
 import scopeEmpty from '../../source/rules/scope-empty';
 
 const messages = {

packages/conventional-changelog-lint/test/rules/scope-enum.js

@@ -1,5 +1,5 @@
 import test from 'ava';
-import {sync as parse} from 'conventional-commits-parser';
+import parse from '../../source/library/parse';
 import scopeEnum from '../../source/rules/scope-enum';
 
 const messages = {