style: refactor parser-preset feature a bit

marionebl · marionebl · commit c981cbe18a2b · 2017-09-03T23:52:14.000+02:00
diff --git a/@commitlint/cli/cli.js b/@commitlint/cli/cli.js
@@ -23,7 +23,7 @@ const rules = {
 };
 
 const configuration = {
-	string: ['from', 'to', 'extends', 'parserPreset'],
+	string: ['from', 'to', 'extends', 'parser-preset'],
 	boolean: ['edit', 'help', 'version', 'quiet', 'color'],
 	alias: {
 		c: 'color',
@@ -34,7 +34,7 @@ const configuration = {
 		h: 'help',
 		v: 'version',
 		x: 'extends',
-		p: 'parserPreset'
+		p: 'parser-preset'
 	},
 	description: {
 		color: 'toggle colored output',
@@ -43,7 +43,7 @@ const configuration = {
 		from: 'lower end of the commit range to lint; applies if edit=false',
 		to: 'upper end of the commit range to lint; applies if edit=false',
 		quiet: 'toggle console output',
-		parserPreset: 'preset parser'
+		'parser-preset': 'configuration preset to use for conventional-commits-parser'
 	},
 	default: {
 		color: true,
@@ -82,7 +82,11 @@ function main(options) {
 		Promise.all(
 			messages.map(commit => {
 				return load(getSeed(flags))
-					.then(opts => core.lint(commit, opts.rules, opts))
+					.then(loaded => {
+						const parserOpts = selectParserOpts(loaded.parserPreset);
+						const opts = parserOpts ? {parserOpts} : undefined;
+						return core.lint(commit, loaded.rules, opts);
+					})
 					.then(report => {
 						const formatted = core.format(report, {color: flags.color});
 
@@ -123,6 +127,21 @@ main(cli).catch(err =>
 	})
 );
 
+
+function selectParserOpts(parserPreset) {
+	if (typeof parserPreset !== 'object') {
+		return undefined;
+	}
+
+	const opts = parserPreset.opts;
+
+	if (typeof opts !== 'object') {
+		return undefined;
+	}
+
+	return opts.parserOpts;
+}
+
 // Catch unhandled rejections globally
 process.on('unhandledRejection', (reason, promise) => {
 	console.log('Unhandled Rejection at: Promise ', promise, ' reason: ', reason);
diff --git a/@commitlint/cli/cli.test.js b/@commitlint/cli/cli.test.js
@@ -14,6 +14,7 @@ const CLI = here('cli.js');
 const SIMPLE = fix('simple');
 const EXTENDS_ROOT = fix('extends-root');
 const EMPTY = fix('empty');
+const PARSER_PRESET = fix('parser-preset');
 
 const HUSKY = tmp.dirSync().name;
 const HUSKY_INTEGRATION = path.join(tmp.dirSync().name, 'integration');
@@ -122,6 +123,15 @@ test('should work with husky commitmsg hook in sub packages', async () => {
 	await rm([upper])();
 });
 
+test('should pick up parser preset', async t => {
+	const cwd = PARSER_PRESET;
+
+	const actual = await t.throws(cli([], {cwd})('type(scope)-ticket subject'));
+	t.true(includes(actual.stdout, 'message may not be empty [subject-empty]'));
+
+	await cli(['--parser-preset', './parser-preset'], {cwd})('type(scope)-ticket subject');
+});
+
 async function init(cwd) {
 	await git(['init'], {cwd})();
 
diff --git a/@commitlint/cli/fixtures/parser-preset/commitlint.config.js b/@commitlint/cli/fixtures/parser-preset/commitlint.config.js
@@ -0,0 +1,7 @@
+module.exports = {
+	rules: {
+		'type-enum': [2, 'always', ['type']],
+		'scope-enum': [2, 'always', ['scope']],
+		'subject-empty': [2, 'never']
+	}
+};
diff --git a/@commitlint/cli/fixtures/parser-preset/parser-preset.js b/@commitlint/cli/fixtures/parser-preset/parser-preset.js
@@ -0,0 +1,6 @@
+module.exports = {
+	parserOpts: {
+		headerPattern: /^(\w*)\((\w*)\)-(\w*)\s(.*)$/,
+		headerCorrespondence: ['type', 'scope', 'ticket', 'subject']
+	}
+};
diff --git a/@commitlint/cli/help.js b/@commitlint/cli/help.js
@@ -22,7 +22,7 @@ module.exports = configuration => {
 			const desc = line[1];
 			const defaults = line[2];
 			const fs = flags.map(
-				flag => (flag.length > 1 ? `--${flag}` : `-${flag}`)
+				flag => (flag.length > 1 ? `--${flag}` : ` -${flag}`)
 			);
 			const ds = defaults ? `, defaults to: ${defaults}` : '';
 			const length = flags.reduce((sum, flag) => sum + flag.length, 0);
diff --git a/@commitlint/core/fixtures/parser-preset-override/commitlint.config.js b/@commitlint/core/fixtures/parser-preset-override/commitlint.config.js
@@ -0,0 +1,4 @@
+module.exports = {
+	extends: ['./extended'],
+	parserPreset: './custom'
+};
diff --git a/@commitlint/core/fixtures/parser-preset-override/custom.js b/@commitlint/core/fixtures/parser-preset-override/custom.js
@@ -0,0 +1,6 @@
+module.exports = {
+	parserOpts: {
+		headerPattern: /.*/,
+	},
+	b: 'b'
+};
diff --git a/@commitlint/core/fixtures/parser-preset-override/extended/custom.js b/@commitlint/core/fixtures/parser-preset-override/extended/custom.js
@@ -0,0 +1,4 @@
+module.exports = Promise.resolve({
+	headerPattern: /^(\w*)(?:\((.*)\))?-(.*)$/,
+	a: 'a'
+});
diff --git a/@commitlint/core/fixtures/parser-preset-override/extended/index.js b/@commitlint/core/fixtures/parser-preset-override/extended/index.js
@@ -0,0 +1,3 @@
+module.exports = {
+	parserPreset: './custom'
+};
diff --git a/@commitlint/core/fixtures/parser-preset/commitlint.config.js b/@commitlint/core/fixtures/parser-preset/commitlint.config.js
@@ -1,3 +1,5 @@
 module.exports = {
-	parserPreset: './conventional-changelog-custom'
+	parserOpts: {
+		parserPreset: './conventional-changelog-custom'
+	}
 };
diff --git a/@commitlint/core/fixtures/parser-preset/conventional-changelog-custom.js b/@commitlint/core/fixtures/parser-preset/conventional-changelog-custom.js
@@ -1,8 +1,6 @@
-const defaultOpts = require('conventional-changelog-angular');
-const _ = require('lodash');
-
-module.exports = defaultOpts.then(data => {
-	const extented = _.cloneDeep(data);
-	extented.parserOpts.headerPattern = /^(\w*)(?:\((.*)\))?-(.*)$/;
-	return extented;
-});
+module.exports = Promise.resolve()
+	.then(() => ({
+		parserOpts: {
+			headerPattern: /^(\w*)(?:\((.*)\))?-(.*)$/
+		}
+	}));
diff --git a/@commitlint/core/src/library/resolve-extends.js b/@commitlint/core/src/library/resolve-extends.js
@@ -1,5 +1,5 @@
 import path from 'path';
-import from from 'resolve-from';
+import resolveFrom from 'resolve-from';
 import {merge, omit} from 'lodash';
 
 // Resolve extend configs
@@ -26,6 +26,7 @@ function loadExtends(config = {}, context = {}) {
 		const load = context.require || require;
 		const resolved = resolveConfig(raw, context);
 		const c = load(resolved);
+		const cwd = path.dirname(resolved);
 
 		// Remove deprecation warning in version 3
 		if (typeof c === 'object' && 'wildcards' in c) {
@@ -34,12 +35,20 @@ function loadExtends(config = {}, context = {}) {
 			);
 		}
 
-		const ctx = merge({}, context, {
-			cwd: path.dirname(resolved)
-		});
+		const ctx = merge({}, context, {cwd});
 
-		if (c && c.parserPreset) {
-			c.parserPreset = resolveId(c.parserPreset, ctx);
+		// Resolve parser preset if none was present before
+		if (!context.parserPreset && typeof c === 'object' && typeof c.parserPreset === 'string') {
+			const resolvedParserPreset = resolveFrom(cwd, c.parserPreset);
+
+			const parserPreset = {
+				name: c.parserPreset,
+				path: `./${path.relative(process.cwd(), resolvedParserPreset)}`.split(path.sep).join('/'),
+				opts: require(resolvedParserPreset)
+			};
+
+			ctx.parserPreset = parserPreset;
+			config.parserPreset = parserPreset;
 		}
 
 		return [...configs, c, ...loadExtends(c, ctx)];
@@ -70,5 +79,5 @@ function resolveConfig(raw, context = {}) {
 }
 
 function resolveId(id, context = {}) {
-	return from(context.cwd || process.cwd(), id);
+	return resolveFrom(context.cwd || process.cwd(), id);
 }
diff --git a/@commitlint/core/src/lint.js b/@commitlint/core/src/lint.js
@@ -55,3 +55,4 @@ export default async (message, rules = {}, opts = {}) => {
 		warnings
 	};
 };
+
diff --git a/@commitlint/core/src/load.js b/@commitlint/core/src/load.js
@@ -18,16 +18,29 @@ export default async (seed = {}) => {
 	const config = valid(merge(raw, seed));
 	const opts = merge({extends: [], rules: {}}, pick(config, 'extends'));
 
+	// Resolve parserPreset key
+	if (typeof config.parserPreset === 'string') {
+		const resolvedParserPreset = resolveFrom(process.cwd(), config.parserPreset);
+
+		config.parserPreset = {
+			name: config.parserPreset,
+			path: `./${path.posix.relative(process.cwd(), resolvedParserPreset)}`.split(path.sep).join('/'),
+			opts: require(resolvedParserPreset)
+		};
+	}
+
 	// Resolve extends key
 	const extended = resolveExtends(opts, {
 		prefix: 'commitlint-config',
-		cwd: raw.config ? path.dirname(raw.config) : process.cwd()
+		cwd: raw.config ? path.dirname(raw.config) : process.cwd(),
+		parserPreset: config.parserPreset
 	});
 
 	const preset = valid(mergeWith(extended, config, w));
 
-	if (preset.parserPreset) {
-		preset.parserOpts = await importFrom(process.cwd(), preset.parserPreset);
+	// Await parser-preset if applicable
+	if (typeof preset.parserPreset === 'object' && typeof preset.parserPreset.opts === 'object') {
+		preset.parserPreset.opts = await preset.parserPreset.opts;
 	}
 
 	// Execute rule config functions if needed
diff --git a/@commitlint/core/src/load.test.js b/@commitlint/core/src/load.test.js
@@ -23,8 +23,17 @@ test('uses seed as configured', async t => {
 
 test('uses seed with parserPreset', async t => {
 	t.context.back = chdir('fixtures/parser-preset');
+
 	const actual = await load({parserPreset: './conventional-changelog-custom'});
-	t.truthy(actual.parserOpts);
+	t.deepEqual(actual.parserPreset, {
+		name: './conventional-changelog-custom',
+		path: './conventional-changelog-custom.js',
+		opts: {
+			parserOpts: {
+				headerPattern: /^(\w*)(?:\((.*)\))?-(.*)$/
+			}
+		}
+	});
 });
 
 test('invalid extend should throw', t => {
@@ -57,10 +66,29 @@ test('recursive extends', async t => {
 	});
 });
 
+test('parser preset overwrites completely instead of merging', async t => {
+	t.context.back = chdir('fixtures/parser-preset-override');
+	const actual = await load();
+
+	t.is(actual.parserPreset.name, './custom');
+	t.is(actual.parserPreset.path, './custom.js');
+	t.is(typeof actual.parserPreset.opts, 'object');
+	t.deepEqual(actual.parserPreset.opts, {
+		b: 'b',
+		parserOpts: {
+			headerPattern: /.*/
+		}
+	});
+});
+
 test('recursive extends with parserPreset', async t => {
 	t.context.back = chdir('fixtures/recursive-parser-preset');
 	const actual = await load();
-	t.truthy(actual.parserOpts);
+
+	t.is(actual.parserPreset.name, './conventional-changelog-custom');
+	t.is(actual.parserPreset.path, './first-extended/second-extended/conventional-changelog-custom.js');
+	t.is(typeof actual.parserPreset.opts, 'object');
+	t.deepEqual(actual.parserPreset.opts.parserOpts.headerPattern, /^(\w*)(?:\((.*)\))?-(.*)$/);
 });
 
 test('ignores unknow keys', async t => {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +module.exports = Promise.resolve({
 +	headerPattern: /^(\w*)(?:\((.*)\))?-(.*)$/,
 +	a: 'a'
 +});
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ parserPreset: './custom'`
	`3`	`+};`