fix: correctly resolve parserOpts #115 #95

Author: marionebl

@commitlint/cli/fixtures/issue-prefixes/commitlint.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+	rules: {
+		'references-empty': [2, 'never']
+	},
+	parserPreset: {
+		parserOpts: {
+			issuePrefixes: ['REF-']
+		}
+	}
+};

@commitlint/cli/fixtures/parser-preset/commitlint.config.js

@@ -1,7 +1,5 @@
 module.exports = {
-	parserOpts: {
-		parserPreset: './parser-preset'
-	},
+	parserPreset: './parser-preset',
 	rules: {
 		'type-enum': [2, 'always', ['type']],
 		'scope-enum': [2, 'always', ['scope']],

@commitlint/cli/src/cli.js

@@ -96,17 +96,17 @@ async function main(options) {
 		throw err;
 	}
 
-	return Promise.all(
-		messages.map(async message => {
-			const loaded = await core.load(getSeed(flags), {cwd: flags.cwd});
-			const parserOpts = selectParserOpts(loaded.parserPreset);
-			const opts = parserOpts ? {parserOpts} : {parserOpts: {}};
+	const loaded = await core.load(getSeed(flags), {cwd: flags.cwd});
+	const parserOpts = selectParserOpts(loaded.parserPreset);
+	const opts = parserOpts ? {parserOpts} : {parserOpts: {}};
 
-			// Strip comments if reading from `.git/COMMIT_EDIT_MSG`
-			if (range.edit) {
-				opts.parserOpts.commentChar = '#';
-			}
+	// Strip comments if reading from `.git/COMMIT_EDIT_MSG`
+	if (range.edit) {
+		opts.parserOpts.commentChar = '#';
+	}
 
+	return Promise.all(
+		messages.map(async message => {
 			const report = await core.lint(message, loaded.rules, opts);
 			const formatted = core.format(report, {color: flags.color});
 
@@ -182,13 +182,11 @@ function selectParserOpts(parserPreset) {
 		return undefined;
 	}
 
-	const opts = parserPreset.opts;
-
-	if (typeof opts !== 'object') {
+	if (typeof parserPreset.parserOpts !== 'object') {
 		return undefined;
 	}
 
-	return opts.parserOpts;
+	return parserPreset.parserOpts;
 }
 
 // Catch unhandled rejections globally

@commitlint/cli/src/cli.test.js

@@ -182,6 +182,12 @@ test('should handle --amend with signoff', async () => {
 	await execa('git', ['commit', '--amend', '--no-edit'], {cwd});
 });
 
+test('should handle linting with issue prefixes', async t => {
+	const cwd = await git.bootstrap('fixtures/issue-prefixes');
+	const actual = await cli([], {cwd})('foobar REF-1');
+	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));

@commitlint/core/src/load.js

@@ -26,7 +26,7 @@ export default async (seed = {}, options = {cwd: process.cwd()}) => {
 		config.parserPreset = {
 			name: config.parserPreset,
 			path: resolvedParserPreset,
-			opts: require(resolvedParserPreset)
+			parserOpts: (await require(resolvedParserPreset)).parserOpts
 		};
 	}
 
@@ -38,13 +38,14 @@ export default async (seed = {}, options = {cwd: process.cwd()}) => {
 	});
 
 	const preset = valid(mergeWith(extended, config, w));
-
 	// Await parser-preset if applicable
 	if (
 		typeof preset.parserPreset === 'object' &&
-		typeof preset.parserPreset.opts === 'object'
+		typeof preset.parserPreset.parserOpts === 'object' &&
+		typeof preset.parserPreset.parserOpts.then === 'function'
 	) {
-		preset.parserPreset.opts = await preset.parserPreset.opts;
+		preset.parserPreset.parserOpts = (await preset.parserPreset
+			.parserOpts).parserOpts;
 	}
 
 	// Execute rule config functions if needed

@commitlint/core/src/load.test.js

@@ -24,12 +24,9 @@ test('uses seed with parserPreset', async t => {
 		},
 		{cwd}
 	);
-
 	t.is(actual.name, './conventional-changelog-custom');
-	t.deepEqual(actual.opts, {
-		parserOpts: {
-			headerPattern: /^(\w*)(?:\((.*)\))?-(.*)$/
-		}
+	t.deepEqual(actual.parserOpts, {
+		headerPattern: /^(\w*)(?:\((.*)\))?-(.*)$/
 	});
 });
 
@@ -134,25 +131,19 @@ test('recursive extends with package.json file', async t => {
 test('parser preset overwrites completely instead of merging', async t => {
 	const cwd = await git.bootstrap('fixtures/parser-preset-override');
 	const actual = await load({}, {cwd});
-
 	t.is(actual.parserPreset.name, './custom');
-	t.is(typeof actual.parserPreset.opts, 'object');
-	t.deepEqual(actual.parserPreset.opts, {
-		b: 'b',
-		parserOpts: {
-			headerPattern: /.*/
-		}
+	t.deepEqual(actual.parserPreset.parserOpts, {
+		headerPattern: /.*/
 	});
 });
 
 test('recursive extends with parserPreset', async t => {
 	const cwd = await git.bootstrap('fixtures/recursive-parser-preset');
 	const actual = await load({}, {cwd});
-
 	t.is(actual.parserPreset.name, './conventional-changelog-custom');
-	t.is(typeof actual.parserPreset.opts, 'object');
+	t.is(typeof actual.parserPreset.parserOpts, 'object');
 	t.deepEqual(
-		actual.parserPreset.opts.parserOpts.headerPattern,
+		actual.parserPreset.parserOpts.headerPattern,
 		/^(\w*)(?:\((.*)\))?-(.*)$/
 	);
 });

@commitlint/resolve-extends/src/index.js

@@ -48,13 +48,12 @@ function loadExtends(config = {}, context = {}) {
 			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)
+				parserOpts: require(resolvedParserPreset)
 			};
 
 			ctx.parserPreset = parserPreset;