fix(core): fall back to globally installed config if available (#127)

marionebl · web-flow · commit 8612eb31cdec · 2017-11-19T10:15:52.000+01:00
* chore: avoid gpg password prompt * test(core): add failing test case for global extends resolving * fix(core): fall back to globally installed config if available #126 * test: use cwd correctly for git config * test: improve testability of global fallback * fix(core): ensure resolve-globals is detected as dependency * fix: use more recent import-fresh * fix: fall back to require-uncached Avoid sindresorhus/import-fresh#6 for the time being * fix: pull in patch releases
diff --git a/@commitlint/core/fixtures/global-install/commitlint.config.js b/@commitlint/core/fixtures/global-install/commitlint.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+	extends: ['@commitlint/config-angular']
+};
diff --git a/@commitlint/core/fixtures/missing-install/commitlint.config.js b/@commitlint/core/fixtures/missing-install/commitlint.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+	extends: ['@commitlint/config-angular']
+};
diff --git a/@commitlint/core/package.json b/@commitlint/core/package.json
@@ -92,7 +92,9 @@
     "find-up": "^2.1.0",
     "lodash": "^4.17.4",
     "path-exists": "^3.0.0",
+    "require-uncached": "^1.0.3",
     "resolve-from": "^3.0.0",
+    "resolve-global": "^0.1.0",
     "semver": "^5.3.0"
   }
 }
diff --git a/@commitlint/core/src/library/resolve-extends.js b/@commitlint/core/src/library/resolve-extends.js
@@ -1,4 +1,6 @@
+import 'resolve-global'; // eslint-disable-line import/no-unassigned-import
 import path from 'path';
+import requireUncached from 'require-uncached';
 import resolveFrom from 'resolve-from';
 import {merge, omit} from 'lodash';
 
@@ -38,12 +40,18 @@ function loadExtends(config = {}, context = {}) {
 		const ctx = merge({}, context, {cwd});
 
 		// Resolve parser preset if none was present before
-		if (!context.parserPreset && typeof c === 'object' && typeof c.parserPreset === 'string') {
+		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('/'),
+				path: `./${path.relative(process.cwd(), resolvedParserPreset)}`
+					.split(path.sep)
+					.join('/'),
 				opts: require(resolvedParserPreset)
 			};
 
@@ -79,5 +87,21 @@ function resolveConfig(raw, context = {}) {
 }
 
 function resolveId(id, context = {}) {
-	return resolveFrom(context.cwd || process.cwd(), id);
+	const cwd = context.cwd || process.cwd();
+	const localPath = resolveFrom.silent(cwd, id);
+
+	if (typeof localPath === 'string') {
+		return localPath;
+	}
+
+	const resolveGlobal = requireUncached('resolve-global');
+	const globalPath = resolveGlobal.silent(id);
+
+	if (typeof globalPath === 'string') {
+		return globalPath;
+	}
+
+	const err = new Error(`Cannot find module "${id}" from "${cwd}"`);
+	err.code = 'MODULE_NOT_FOUND';
+	throw err;
 }
diff --git a/@commitlint/core/src/library/resolve-extends.test.js b/@commitlint/core/src/library/resolve-extends.test.js
@@ -1,4 +1,7 @@
 import test from 'ava';
+import execa from 'execa';
+import {fix} from '@commitlint/test';
+import * as sander from '@marionebl/sander';
 import resolveExtends from './resolve-extends';
 
 const id = id => id;
@@ -14,6 +17,50 @@ test('returns an equivalent object as passed in', t => {
 	t.deepEqual(actual, expected);
 });
 
+test.serial('falls back to global install', async t => {
+	const prev = process.env.PREFIX;
+
+	const cwd = await fix.bootstrap('fixtures/global-install');
+	const prefix = `${cwd}/commitlint-npm-packages`;
+
+	const npm = args => execa('npm', args, {cwd});
+
+	await sander.mkdir(cwd, 'commitlint-npm-packages');
+
+	process.env.PREFIX = prefix;
+
+	await npm([
+		'install',
+		'--global',
+		'@commitlint/config-angular',
+		'--prefix',
+		prefix
+	]);
+
+	const expected = {extends: ['@commitlint/config-angular']};
+	t.notThrows(() => resolveExtends(expected));
+
+	process.env.PREFIX = prev;
+});
+
+test.serial('fails for missing extends', async t => {
+	const prev = process.env.PREFIX;
+
+	const cwd = await fix.bootstrap('fixtures/missing-install');
+	const prefix = `${cwd}/commitlint-npm-packages`;
+
+	process.env.PREFIX = prefix;
+
+	const input = {extends: ['@commitlint/foo-bar']};
+
+	t.throws(
+		() => resolveExtends(input, {cwd}),
+		/Cannot find module "@commitlint\/foo-bar" from/
+	);
+
+	process.env.PREFIX = prev;
+});
+
 test('uses empty prefix by default', t => {
 	const input = {extends: ['extender-name']};
 
diff --git a/@packages/test/src/git.js b/@packages/test/src/git.js
@@ -36,6 +36,7 @@ async function setup(cwd) {
 	try {
 		await execa('git', ['config', 'user.name', 'ava'], {cwd});
 		await execa('git', ['config', 'user.email', 'test@example.com'], {cwd});
+		await execa('git', ['config', 'commit.gpgsign', 'false'], {cwd});
 	} catch (err) {
 		console.warn(`git config in ${cwd} failed`, err.message);
 	}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ['@commitlint/config-angular']`
	`3`	`+};`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,9 @@`
`92`	`92`	`"find-up": "^2.1.0",`
`93`	`93`	`"lodash": "^4.17.4",`
`94`	`94`	`"path-exists": "^3.0.0",`
	`95`	`+ "require-uncached": "^1.0.3",`
`95`	`96`	`"resolve-from": "^3.0.0",`
	`97`	`+ "resolve-global": "^0.1.0",`
`96`	`98`	`"semver": "^5.3.0"`
`97`	`99`	`}`
`98`	`100`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ async function setup(cwd) {`
`36`	`36`	`try {`
`37`	`37`	`await execa('git', ['config', 'user.name', 'ava'], {cwd});`
`38`	`38`	`await execa('git', ['config', 'user.email', '[email protected]'], {cwd});`
	`39`	`+ await execa('git', ['config', 'commit.gpgsign', 'false'], {cwd});`
`39`	`40`	`} catch (err) {`
`40`	`41`	console.warn(`git config in ${cwd} failed`, err.message);
`41`	`42`	`}`