feat: basic implementation of config command

Author: marionebl

@commitlint/cli/src/cli.js

@@ -8,31 +8,34 @@ const pkg = require('../package');
 const commands = require('./commands');
 
 const FORMATS = ['commitlint', 'json'];
+const COMMANDS = ['config'];
+
+const HELP = `
+Commands
+commitlint              lint commits, [input] reads from stdin if --edit, --from and --to are omitted
+
+Options
+--cwd, -d              directory to execute in, defaults to: process.cwd()
+--extends, -x          array of shareable configurations to extend
+--format, -o           format to use, defaults to "commitlint". available: "commitlint", "json"
+--parser-preset, -p    configuration preset to use for conventional-commits-parser
+--quiet, -q            toggle console output
+
+commitlint
+  --color, -c            toggle colored output, defaults to: true
+  --edit, -e             read last commit message from the specified file or falls back to ./.git/COMMIT_EDITMSG
+  --from, -f             lower end of the commit range to lint; applies if edit=false
+  --to, -t               upper end of the commit range to lint; applies if edit=false
+
+Usage
+$ echo "some commit" | commitlint
+$ commitlint --to=master
+$ commitlint --from=HEAD~1
+`;
 
 const cli = meow(
 	{
-		help: `
-		Commands
-		  commitlint              lint commits, [input] reads from stdin if --edit, --from and --to are omitted
-
-		Options
-		  --cwd, -d              directory to execute in, defaults to: process.cwd()
-		  --extends, -x          array of shareable configurations to extend
-		  --format, -o           formatter to use, defaults to "commitlint". available: "commitlint", "json"
-		  --parser-preset, -p    configuration preset to use for conventional-commits-parser
-		  --quiet, -q            toggle console output
-
-		  commitlint
-		    --color, -c            toggle colored output, defaults to: true
-		    --edit, -e             read last commit message from the specified file or falls back to ./.git/COMMIT_EDITMSG
-		    --from, -f             lower end of the commit range to lint; applies if edit=false
-		    --to, -t               upper end of the commit range to lint; applies if edit=false
-
-		Usage
-		  $ echo "some commit" | commitlint
-		  $ commitlint --to=master
-		  $ commitlint --from=HEAD~1
-		`,
+		help: HELP,
 		description: `${pkg.name}@${pkg.version} - ${pkg.description}`
 	},
 	{
@@ -60,7 +63,18 @@ const cli = meow(
 			quiet: false
 		},
 		unknown(arg) {
-			console.log(`unknown flags: ${arg}`);
+			if (COMMANDS.includes(arg)) {
+				return;
+			}
+
+			console.log(HELP);
+
+			if (!arg.startsWith('-') && !COMMANDS.includes(arg)) {
+				console.log(`<command> must be on of: [config], received "${arg}"`);
+			} else {
+				console.log(`unknown flags: ${arg}`);
+			}
+
 			process.exit(1);
 		}
 	}
@@ -86,8 +100,28 @@ async function main(options) {
 	const raw = Array.isArray(options.input) ? options.input : [];
 	const [command] = raw;
 
+	const flags = normalizeFlags(options.flags);
+
 	if (!command) {
-		return commands.lint(raw, normalizeFlags(options.flags));
+		return commands.lint(raw, flags);
+	}
+
+	switch (command) {
+		case 'config':
+			return commands.config(raw, {
+				cwd: flags.cwd,
+				extends: flags.extends,
+				format: flags.format,
+				parserPreset: flags.parserPreset
+			});
+		default: {
+			const err = new Error(
+				`<command> must be on of: [config], received "${command}"`
+			);
+			err.help = true;
+			err.type = pkg.name;
+			throw err;
+		}
 	}
 }
 

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

@@ -32,6 +32,15 @@ test('should reprint input from stdin', async t => {
 	t.true(actual.stdout.includes('foo: bar'));
 });
 
+test('should throw for unknown command', async t => {
+	const cwd = await git.bootstrap('fixtures/empty');
+	const actual = await cli(['foo'], {cwd})();
+	t.is(actual.code, 1);
+	t.true(
+		actual.stdout.includes('<command> must be on of: [config], received "foo"')
+	);
+});
+
 test('should produce no success output with --quiet flag', async t => {
 	const cwd = await git.bootstrap('fixtures/empty');
 	const actual = await cli(['--quiet'], {cwd})('foo: bar');

@commitlint/cli/src/commands/cmd-config.js

@@ -0,0 +1,20 @@
+const core = require('@commitlint/core');
+const getSeed = require('./get-seed').getSeed;
+
+module.exports.config = config;
+
+async function config(_, flags) {
+	const loaded = await core.load(getSeed(flags), {cwd: flags.cwd});
+	switch (flags.format) {
+		case 'commitlint':
+			return console.log(loaded);
+		case 'json':
+			return console.log(JSON.stringify(loaded));
+		default: {
+			const err = new Error(`unknown format: ${flags.format}`);
+			err.type = 'commitlint';
+			err.help = true;
+			throw err;
+		}
+	}
+}

@commitlint/cli/src/commands/lint.js renamed to @commitlint/cli/src/commands/cmd-lint.js

@@ -33,12 +33,12 @@ async function lint(rawInput, flags) {
 	}
 
 	const loaded = await core.load(getSeed(flags), {cwd: flags.cwd});
-	const parserOpts = selectParserOpts(loaded.parserPreset);
-	const opts = parserOpts ? {parserOpts} : undefined;
 
 	const results = await all(messages, async msg => {
 		return {
-			report: await core.lint(msg, loaded.rules, opts),
+			report: await core.lint(msg, loaded.rules, {
+				parserOpts: loaded.parserPreset.opts
+			}),
 			input: msg
 		};
 	});
@@ -92,20 +92,6 @@ function error(message, opts = {}) {
 	return err;
 }
 
-function selectParserOpts(parserPreset) {
-	if (typeof parserPreset !== 'object') {
-		return undefined;
-	}
-
-	const opts = parserPreset.opts;
-
-	if (typeof opts !== 'object') {
-		return undefined;
-	}
-
-	return opts.parserOpts;
-}
-
 function checkFromStdin(input, flags) {
 	return input.length === 0 && !checkFromRepository(flags);
 }

@commitlint/cli/src/commands/index.js

@@ -1,3 +1,4 @@
 module.exports = {
-	lint: require('./lint').lint
+	config: require('./cmd-config').config,
+	lint: require('./cmd-lint').lint
 };

@commitlint/core/src/library/resolve-extends.js

@@ -5,9 +5,10 @@ import resolveFrom from 'resolve-from';
 import {merge, omit} from 'lodash';
 
 // Resolve extend configs
-export default function resolveExtends(config = {}, context = {}) {
+export default async function resolveExtends(config = {}, context = {}) {
 	const {extends: e} = config;
-	const extended = loadExtends(config, context).reduceRight(
+
+	const extended = (await loadExtends(config, context)).reduceRight(
 		(r, c) => merge(r, omit(c, 'extends')),
 		e ? {extends: e} : {}
 	);
@@ -23,8 +24,38 @@ export default function resolveExtends(config = {}, context = {}) {
 }
 
 // (any, string, string, Function) => any[];
-function loadExtends(config = {}, context = {}) {
-	return (config.extends || []).reduce((configs, raw) => {
+async function loadExtends(config = {}, context = {}) {
+	return (config.extends || []).reduce(async (configs, raw) => {
+		const load = context.require || require;
+		const resolved = resolveConfig(raw, context);
+		const c = load(resolved);
+		const cwd = path.dirname(resolved);
+
+		const ctx = merge({}, context, {cwd});
+
+		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: (await require(resolvedParserPreset)).parserOpts
+			};
+
+			ctx.parserPreset = parserPreset;
+			config.parserPreset = parserPreset;
+		}
+
+		return [...configs, c, ...(await loadExtends(c, ctx))];
+	}, Promise.resolve([]));
+
+	/* Return (config.extends || []).reduce((configs, raw) => {
 		const load = context.require || require;
 		const resolved = resolveConfig(raw, context);
 		const c = load(resolved);
@@ -60,7 +91,7 @@ function loadExtends(config = {}, context = {}) {
 		}
 
 		return [...configs, c, ...loadExtends(c, ctx)];
-	}, []);
+	}, []); */
 }
 
 function getId(raw = '', prefix = '') {
@@ -80,7 +111,11 @@ function resolveConfig(raw, context = {}) {
 		const legacy = getId(raw, 'conventional-changelog-lint-config');
 		const resolved = resolve(legacy, context);
 		console.warn(
-			`Resolving ${raw} to legacy config ${legacy}. To silence this warning raise an issue at 'npm repo ${legacy}' to rename to ${id}.`
+			`Resolving ${raw} to legacy config ${
+				legacy
+			}. To silence this warning raise an issue at 'npm repo ${
+				legacy
+			}' to rename to ${id}.`
 		);
 		return resolved;
 	}