refactor: move ignore wildcard matching to isIgnore method

* hide former wildcards inside new utility
* remove related documentation
* emit warning when wildcard configuration is passed

BREAKING CHANGES
* wildcards config is now ignored entirely

Author: marionebl

packages/conventional-changelog-lint/package.json

@@ -61,7 +61,9 @@
         ]
       },
       "production": {
-        "ignore": ["**/*.test.js"]
+        "ignore": [
+          "**/*.test.js"
+        ]
       }
     },
     "presets": [
@@ -174,6 +176,7 @@
     "meow": "3.7.0",
     "mz": "2.6.0",
     "pos": "0.4.2",
-    "rc": "1.1.7"
+    "rc": "1.1.7",
+    "semver": "^5.3.0"
   }
 }

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

@@ -3,47 +3,28 @@ import format from './library/format';
 import getConfiguration from './library/get-configuration';
 import getMessages from './library/get-messages';
 import getPreset from './library/get-preset';
+import isIgnored from './library/is-ignored';
 import parse from './library/parse';
 
 export {format, getConfiguration, getMessages, getPreset};
 
 export default async (message, options = {}) => {
-	const {
-		configuration: {
-			rules,
-			wildcards
-		}
-	} = options;
-
-	// Parse the commit message
-	const parsed = parse(message);
-
-	// Wildcard matches skip the linting
-	const bails = Object.entries(wildcards)
-		.filter(entry => {
-			const [, pattern] = entry;
-			return Array.isArray(pattern);
-		})
-		.filter(entry => {
-			const [, pattern] = entry;
-			const expression = new RegExp(...pattern);
-			return parsed.header.match(expression);
-		})
-		.map(entry => entry[0]);
+	const {configuration} = options;
 
 	// Found a wildcard match, skip
-	if (bails.length > 0) {
+	if (isIgnored(message)) {
 		return {
 			valid: true,
-			wildcards: bails,
-			rules: [],
-			warnings: [],
-			errors: []
+			errors: [],
+			warnings: []
 		};
 	}
 
+	// Parse the commit message
+	const parsed = parse(message);
+
 	// Validate against all rules
-	const results = Object.entries(rules)
+	const results = Object.entries(configuration.rules)
 		.filter(entry => {
 			const [, [level]] = entry;
 			return level > 0;

packages/conventional-changelog-lint/source/library/is-ignored.js

@@ -0,0 +1,11 @@
+import semver from 'semver';
+
+const WILDCARDS = [
+	c => c.match(/^(Merge pull request)|(Merge (.*?) into (.*?)|(Merge branch (.*?))$)/),
+	c => c.match(/^(R|r)evert (.*)/),
+	c => semver.valid(c)
+];
+
+export default function isIgnored(commit = '') {
+	return WILDCARDS.some(w => w(commit));
+}

packages/conventional-changelog-lint/source/library/is-ignored.test.js

@@ -0,0 +1,42 @@
+import test from 'ava';
+import isIgnored from './is-ignored';
+
+test('should return false when called without arguments', t => {
+	t.false(isIgnored());
+});
+
+test('should return false when called with empty string', t => {
+	t.false(isIgnored(''));
+});
+
+test('should return false for normal commit', t => {
+	t.false(isIgnored('initial commit'));
+});
+
+test('should return false for branch merges', t => {
+	t.true(isIgnored('Merge branch \'iss53\''));
+});
+
+test('should return true for merged PRs', t => {
+	t.true(isIgnored('Merge pull request #369'));
+});
+
+test('should return true for revert commits', t => {
+	t.true(isIgnored(`Revert "docs: add recipe for linting of all commits in a PR (#36)"\n\nThis reverts commit 1e69d542c16c2a32acfd139e32efa07a45f19111.`));
+	t.true(isIgnored(`revert "docs: add recipe for linting of all commits in a PR (#36)"\n\nThis reverts commit 1e69d542c16c2a32acfd139e32efa07a45f19111.`));
+});
+
+test('should return true for npm version commits', t => {
+	t.true(isIgnored(`0.0.1`));
+	t.true(isIgnored(`0.1.0`));
+	t.true(isIgnored(`1.0.0`));
+	t.true(isIgnored(`0.0.1-alpha`));
+	t.true(isIgnored(`0.0.1-some-crazy-tag`));
+	t.true(isIgnored(`0.0.1-0`));
+	t.true(isIgnored(`0.0.1-999`));
+	t.true(isIgnored(`0.0.1-alpha.0`));
+	t.true(isIgnored(`0.0.1-alpha.999`));
+	t.true(isIgnored(`0.0.1-some-crazy-tag.0`));
+	t.true(isIgnored(`0.0.1-some-crazy-tag.999`));
+	t.true(isIgnored(`0.0.1-1e69d54`));
+});

packages/conventional-changelog-lint/source/library/resolve-extends.js

@@ -7,6 +7,12 @@ const cwd = importFrom.bind(null, process.cwd());
 export default function resolveExtends(config = {}, prefix = '', key = 'extends', require = cwd) {
 	const extended = loadExtends(config, prefix, key, require)
 		.reduceRight((r, c) => merge(r, omit(c, [key])), config[key] ? {[key]: config[key]} : {});
+
+	// Remove deprecation warning in version 3
+	if (typeof c === 'object' && 'wildcards' in config) {
+		console.warn(`'wildcards' found in top-level configuration ignored. Remove them from your config to silence this warning.`);
+	}
+
 	return merge({}, extended, config);
 }
 
@@ -16,6 +22,12 @@ function loadExtends(config = {}, prefix = '', key = 'extends', require = cwd) {
 	return toExtend.reduce((configs, raw) => {
 		const id = [prefix, raw].filter(String).join('-');
 		const c = require(id);
+
+		// Remove deprecation warning in version 3
+		if (typeof c === 'object' && 'wildcards' in c) {
+			console.warn(`'wildcards' found in '${id}' ignored. Raise an issue at 'npm repo ${id}' to remove the wildcards and silence this warning.`);
+		}
+
 		return [...configs, c, ...loadExtends(c, prefix, key, require)];
 	}, []);
 }