feat(config-rush-scopes): add config for rush monorepo (#2878)

* feat(config-rush-scopes): add config for rush monorepo

* fix(config-rush-scopes): support older NodeJS

Author: lembdev

@commitlint/config-rush-scopes/CHANGELOG.md

@@ -0,0 +1,4 @@
+{
+  "name": "a",
+  "version": "1.0.0"
+}

@commitlint/config-rush-scopes/fixtures/basic/packages/a/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "b",
+  "version": "1.0.0"
+}

@commitlint/config-rush-scopes/fixtures/basic/packages/b/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@packages/a",
+  "version": "1.0.0"
+}

@commitlint/config-rush-scopes/fixtures/basic/rush.json

@@ -0,0 +1,4 @@
+{
+  "name": "@packages/b",
+  "version": "1.0.0"
+}

@commitlint/config-rush-scopes/fixtures/empty/rush.json

@@ -0,0 +1,33 @@
+const Path = require('path');
+const util = require('util');
+const fs = require('fs');
+const jsonc = require('jsonc');
+
+const readFilePromisifed = util.promisify(fs.readFile);
+
+module.exports = {
+	utils: {getPackages},
+	rules: {
+		'scope-enum': (ctx) =>
+			getPackages(ctx).then((packages) => [2, 'always', packages]),
+	},
+};
+
+function getPackages(context) {
+	return Promise.resolve()
+		.then(() => {
+			const ctx = context || {};
+			const cwd = ctx.cwd || process.cwd();
+
+			return readFilePromisifed(Path.join(cwd, 'rush.json'), {encoding: 'utf8'})
+				.then((content) => jsonc.parse(content))
+				.then(({projects}) => projects)
+				.catch(() => []);
+		})
+		.then((packages) => {
+			return packages
+				.map((pkg) => pkg.packageName)
+				.filter(Boolean)
+				.map((name) => (name.charAt(0) === '@' ? name.split('/')[1] : name));
+		});
+}

@commitlint/config-rush-scopes/fixtures/scoped/@packages/a/package.json

@@ -0,0 +1,69 @@
+import {npm} from '@commitlint/test';
+import config from '.';
+
+test('exports rules key', () => {
+	expect(config).toHaveProperty('rules');
+});
+
+test('rules hold object', () => {
+	expect(config).toMatchObject({
+		rules: expect.any(Object),
+	});
+});
+
+test('rules contain scope-enum', () => {
+	expect(config).toMatchObject({
+		rules: {
+			'scope-enum': expect.anything(),
+		},
+	});
+});
+
+test('scope-enum is function', () => {
+	expect(config).toMatchObject({
+		rules: {
+			'scope-enum': expect.any(Function),
+		},
+	});
+});
+
+test('scope-enum does not throw for missing context', async () => {
+	const {'scope-enum': fn} = config.rules;
+	await expect(fn()).resolves.toBeTruthy();
+});
+
+test('scope-enum has expected severity', async () => {
+	const {'scope-enum': fn} = config.rules;
+	const [severity] = await fn();
+	expect(severity).toBe(2);
+});
+
+test('scope-enum has expected modifier', async () => {
+	const {'scope-enum': fn} = config.rules;
+	const [, modifier] = await fn();
+	expect(modifier).toBe('always');
+});
+
+test('returns empty value for empty rush repository', async () => {
+	const {'scope-enum': fn} = config.rules;
+	const cwd = await npm.bootstrap('fixtures/empty', __dirname);
+	const [, , value] = await fn({cwd});
+	expect(value).toEqual([]);
+});
+
+test('returns expected value for basic rush repository', async () => {
+	const {'scope-enum': fn} = config.rules;
+	const cwd = await npm.bootstrap('fixtures/basic', __dirname);
+
+	const [, , value] = await fn({cwd});
+	expect(value).toEqual(['a', 'b']);
+});
+
+test('returns expected value for scoped lerna repository', async () => {
+	const {'scope-enum': fn} = config.rules;
+	const cwd = await npm.bootstrap('fixtures/scoped', __dirname);
+
+	const [, , value] = await fn({cwd});
+
+	expect(value).toEqual(['a', 'b']);
+});