chore: introduce cwd awareness

Author: marionebl

@commitlint/cli/cli.js

@@ -23,10 +23,11 @@ const rules = {
 };
 
 const configuration = {
-	string: ['from', 'to', 'extends', 'parser-preset'],
+	string: ['cwd', 'from', 'to', 'extends', 'parser-preset'],
 	boolean: ['edit', 'help', 'version', 'quiet', 'color'],
 	alias: {
 		c: 'color',
+		d: 'cwd',
 		e: 'edit',
 		f: 'from',
 		t: 'to',
@@ -38,15 +39,18 @@ const configuration = {
 	},
 	description: {
 		color: 'toggle colored output',
+		cwd: 'directory to execute in',
 		edit: 'read last commit message found in ./git/COMMIT_EDITMSG',
 		extends: 'array of shareable configurations to extend',
 		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',
-		'parser-preset': 'configuration preset to use for conventional-commits-parser'
+		'parser-preset':
+			'configuration preset to use for conventional-commits-parser'
 	},
 	default: {
 		color: true,
+		cwd: process.cwd(),
 		edit: false,
 		from: null,
 		to: null,
@@ -67,21 +71,21 @@ const cli = meow(
 	configuration
 );
 
-const load = seed => core.load(seed);
+const load = (seed, opts) => core.load(seed, opts);
 
 function main(options) {
 	const raw = options.input;
 	const flags = options.flags;
 	const fromStdin = rules.fromStdin(raw, flags);
 
 	const range = pick(flags, 'edit', 'from', 'to');
-	const input = fromStdin ? stdin() : core.read(range);
+	const input = fromStdin ? stdin() : core.read(range, {cwd: flags.cwd});
 	const fmt = new chalk.constructor({enabled: flags.color});
 
 	return input.then(raw => (Array.isArray(raw) ? raw : [raw])).then(messages =>
 		Promise.all(
 			messages.map(commit => {
-				return load(getSeed(flags))
+				return load(getSeed(flags), {cwd: flags.cwd})
 					.then(loaded => {
 						const parserOpts = selectParserOpts(loaded.parserPreset);
 						const opts = parserOpts ? {parserOpts} : undefined;
@@ -127,7 +131,6 @@ main(cli).catch(err =>
 	})
 );
 
-
 function selectParserOpts(parserPreset) {
 	if (typeof parserPreset !== 'object') {
 		return undefined;

@commitlint/cli/cli.test.js

@@ -137,8 +137,8 @@ test('should work with husky commitmsg hook in sub packages', async () => {
 
 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})(

@commitlint/core/fixtures/legacy/.conventional-changelog-lintrc

@@ -0,0 +1,6 @@
+module.exports = {
+	extends: ['./second-extended'],
+	rules: {
+		one: 1
+	}
+};

@commitlint/core/fixtures/overriden-legacy/.conventional-changelog-lintrc

@@ -1,6 +1 @@
-module.exports = {
-	extends: ['./second-extended'],
-	rules: {
-		one: 1
-	}
-};
+module.exports = require('./commitlint.config.js');

@commitlint/core/fixtures/overriden-legacy/commitlint.config.js

@@ -1,8 +1,7 @@
-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(() => {
+	return {
+		parserOpts: {
+			headerPattern: /^(\w*)(?:\((.*)\))?-(.*)$/
+		}
+	};
 });

@commitlint/core/fixtures/recursive-extends/first-extended/commitlint.config.js

@@ -63,7 +63,6 @@
   "license": "MIT",
   "devDependencies": {
     "@commitlint/utils": "^3.1.1",
-    "ansi-styles": "3.1.0",
     "ava": "0.22.0",
     "babel-cli": "^6.26.0",
     "babel-preset-commitlint": "^3.2.0",
@@ -73,27 +72,26 @@
     "dependency-check": "2.7.0",
     "execa": "0.6.3",
     "globby": "6.1.0",
-    "has-ansi": "3.0.0",
     "import-from": "2.1.0",
     "nyc": "10.3.2",
     "path-exists": "3.0.0",
     "resolve-from": "3.0.0",
+    "rimraf": "2.6.1",
     "xo": "0.18.2"
   },
   "dependencies": {
-    "@marionebl/sander": "^0.6.1",
+    "@marionebl/git-raw-commits": "^1.2.0",
+    "@marionebl/sander": "^0.6.0",
     "babel-runtime": "^6.23.0",
     "chalk": "^2.0.1",
     "conventional-changelog-angular": "^1.3.3",
     "conventional-commits-parser": "^1.3.0",
     "cosmiconfig": "^3.0.1",
     "find-up": "^2.1.0",
     "franc": "^2.0.0",
-    "git-raw-commits": "^1.1.2",
     "lodash": "^4.17.4",
     "path-exists": "^3.0.0",
     "pos": "^0.4.2",
-    "rc": "^1.1.7",
     "resolve-from": "^3.0.0",
     "semver": "^5.3.0"
   }

@commitlint/core/fixtures/recursive-extends/first-extended/index.js

@@ -1,7 +1,5 @@
 import test from 'ava';
-import hasAnsi from 'has-ansi';
 import chalk from 'chalk';
-import {yellow, red, magenta, blue} from 'ansi-styles';
 import {includes} from 'lodash';
 import format from './format';
 
@@ -49,19 +47,6 @@ test('returns a correct of empty .errors and .warnings', t => {
 	t.true(includes(msg, '1 problems, 1 warnings'));
 });
 
-test('colors messages by default', t => {
-	const [msg] = format({
-		errors: [],
-		warnings: []
-	});
-	t.true(hasAnsi(msg));
-});
-
-test('does not color messages if configured', t => {
-	const [msg] = format({}, {color: false});
-	t.false(hasAnsi(msg));
-});
-
 test('uses appropriate signs by default', t => {
 	const [err, warn] = format({
 		errors: [
@@ -110,54 +95,3 @@ test('uses signs as configured', t => {
 	t.true(includes(err, 'ERR'));
 	t.true(includes(warn, 'WRN'));
 });
-
-test('uses appropriate colors by default', t => {
-	const [err, warn] = format({
-		errors: [
-			{
-				level: 2,
-				name: 'error-name',
-				message: 'There was an error'
-			}
-		],
-		warnings: [
-			{
-				level: 1,
-				name: 'warning-name',
-				message: 'There was a problem'
-			}
-		]
-	});
-
-	t.true(includes(err, red.open));
-	t.true(includes(warn, yellow.open));
-});
-
-if (process.platform !== 'win32') {
-	test('uses colors as configured', t => {
-		const [err, warn] = format(
-			{
-				errors: [
-					{
-						level: 2,
-						name: 'error-name',
-						message: 'There was an error'
-					}
-				],
-				warnings: [
-					{
-						level: 1,
-						name: 'warning-name',
-						message: 'There was a problem'
-					}
-				]
-			},
-			{
-				colors: ['white', 'magenta', 'blue']
-			}
-		);
-
-		t.true(includes(err, blue.open));
-		t.true(includes(warn, magenta.open));
-	});
-}

@commitlint/core/fixtures/recursive-parser-preset/first-extended/second-extended/conventional-changelog-custom.js

@@ -0,0 +1,16 @@
+import path from 'path';
+import up from 'find-up';
+
+export default toplevel;
+
+// Find the next git root
+// (start: string) => Promise<string | null>
+async function toplevel(cwd) {
+	const found = await up('.git', {cwd});
+
+	if (typeof found !== 'string') {
+		return found;
+	}
+
+	return path.join(found, '..');
+}

@commitlint/core/package.json

@@ -1,43 +1,43 @@
 import path from 'path';
-import {entries, merge, mergeWith, pick} from 'lodash';
-import rc from 'rc';
 import cosmiconfig from 'cosmiconfig';
+import {entries, merge, mergeWith, pick} from 'lodash';
 import resolveFrom from 'resolve-from';
-import up from 'find-up';
 
-import resolveExtends from './library/resolve-extends';
 import executeRule from './library/execute-rule';
+import resolveExtends from './library/resolve-extends';
+import toplevel from './library/toplevel';
 
 const w = (a, b) => (Array.isArray(b) ? b : undefined);
 const valid = input => pick(input, 'extends', 'rules', 'parserPreset');
 
-export default async (seed = {}) => {
-	// Obtain config from .rc files
-	const raw = await file();
+export default async (seed = {}, options = {cwd: ''}) => {
+	const explorer = cosmiconfig('commitlint', {
+		rcExtensions: true,
+		stopDir: await toplevel(options.cwd)
+	});
+
+	const raw = (await explorer.load(options.cwd)) || {};
+	const base = raw.filepath ? path.dirname(raw.filepath) : options.cwd;
+
 	// Merge passed config with file based options
-	const config = valid(merge(raw, seed));
+	const config = valid(merge(raw.config, seed));
 	const opts = merge({extends: [], rules: {}}, pick(config, 'extends'));
 
 	// Resolve parserPreset key
 	if (typeof config.parserPreset === 'string') {
-		const resolvedParserPreset = resolveFrom(
-			process.cwd(),
-			config.parserPreset
-		);
+		const resolvedParserPreset = resolveFrom(base, config.parserPreset);
 
 		config.parserPreset = {
 			name: config.parserPreset,
-			path: `./${path.posix.relative(process.cwd(), resolvedParserPreset)}`
-				.split(path.sep)
-				.join('/'),
+			path: resolvedParserPreset,
 			opts: require(resolvedParserPreset)
 		};
 	}
 
 	// Resolve extends key
 	const extended = resolveExtends(opts, {
 		prefix: 'commitlint-config',
-		cwd: raw.config ? path.dirname(raw.config) : process.cwd(),
+		cwd: base,
 		parserPreset: config.parserPreset
 	});
 
@@ -80,49 +80,3 @@ export default async (seed = {}) => {
 		return registry;
 	}, preset);
 };
-
-async function file() {
-	const legacy = rc('conventional-changelog-lint');
-	const legacyFound = typeof legacy.config === 'string';
-	const explorer = cosmiconfig('commitlint', {
-		rcExtensions: true,
-		stopDir: await toplevel()
-	});
-	const config = await explorer.load('.');
-
-	if (legacyFound && !config) {
-		console.warn(
-			`Using legacy ${path.relative(
-				process.cwd(),
-				legacy.config
-			)}. Rename to commitlint.config.js to silence this warning.`
-		);
-	}
-
-	if (legacyFound && config) {
-		console.warn(
-			`Ignored legacy ${path.relative(
-				process.cwd(),
-				legacy.config
-			)} as commitlint.config.js superseeds it. Remove .conventional-changelog-lintrc to silence this warning.`
-		);
-	}
-
-	if (config) {
-		return config.config;
-	}
-
-	return legacy;
-}
-
-// Find the next git root
-// (start: string) => Promise<string | null>
-async function toplevel(cwd = process.cwd()) {
-	const found = await up('.git', {cwd});
-
-	if (typeof found !== 'string') {
-		return found;
-	}
-
-	return path.join(found, '..');
-}