fix(config-lerna-scopes): remove deprecated @lerna/project dependency

Author: janbiasi

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

@@ -1,5 +1,4 @@
 {
-  "lerna": "4",
   "version": "1.0.0",
   "packages": ["packages/*"]
 }

@commitlint/config-lerna-scopes/fixtures/basic/package.json

@@ -1,8 +1,4 @@
 {
   "name": "basic",
-  "version": "1.0.0",
-  "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
-  }
+  "version": "1.0.0"
 }

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

@@ -1,4 +1,4 @@
 {
-  "name": "a",
+  "name": "@commitlint-lerna-scopes/basic-a",
   "version": "1.0.0"
 }

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

@@ -1,4 +1,4 @@
 {
-  "name": "b",
+  "name": "@commitlint-lerna-scopes/basic-b",
   "version": "1.0.0"
 }

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

@@ -1,5 +1,4 @@
 {
-  "lerna": "4",
   "version": "1.0.0",
   "packages": ["packages/*"]
 }

@commitlint/config-lerna-scopes/fixtures/empty/package.json

@@ -1,8 +1,4 @@
 {
   "name": "empty",
-  "version": "1.0.0",
-  "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
-  }
+  "version": "1.0.0"
 }

@commitlint/config-lerna-scopes/fixtures/modules/lerna.json

@@ -1,5 +1,4 @@
 {
-  "lerna": "4",
   "version": "1.0.0",
   "packages": ["packages/*"]
 }

@commitlint/config-lerna-scopes/fixtures/modules/package.json

@@ -1,8 +1,4 @@
 {
   "name": "basic",
-  "version": "1.0.0",
-  "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
-  }
+  "version": "1.0.0"
 }

@commitlint/config-lerna-scopes/fixtures/modules/packages/a/package.json

@@ -1,4 +1,4 @@
 {
-  "name": "a",
+  "name": "@commitlint-lerna-scopes/modules-a",
   "version": "1.0.0"
 }

@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/a/nested-a/node_modules/dependency-a/package.json

@@ -0,0 +1,4 @@
+{
+  "version": "1.0.0",
+  "packages": ["packages/**"]
+}

@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/a/nested-a/package.json

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

@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/b/nested-b/node_modules/dependency-b/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@commitlint-lerna-scopes/nested-a",
+  "version": "1.0.0"
+}

@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/b/nested-b/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@commitlint-lerna-scopes/nested-b",
+  "version": "1.0.0"
+}

@commitlint/config-lerna-scopes/fixtures/nested-workspaces/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "@commitlint-lerna-scopes/nested-c",
+  "version": "1.0.0"
+}

@commitlint/config-lerna-scopes/fixtures/nested/lerna.json

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

@commitlint/config-lerna-scopes/fixtures/nested/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "no-packages-declaration",
+  "version": "1.0.0",
+  "workspaces": ["./packages/*"]
+}

@commitlint/config-lerna-scopes/fixtures/nested/packages/a/nested-a/package.json

@@ -1,4 +1,4 @@
 {
-  "name": "@packages/a",
+  "name": "@commitlint-lerna-scopes/scoped-a",
   "version": "1.0.0"
 }

@commitlint/config-lerna-scopes/fixtures/nested/packages/b/nested-b/package.json

@@ -1,4 +1,4 @@
 {
-  "name": "@packages/b",
+  "name": "@commitlint-lerna-scopes/scoped-b",
   "version": "1.0.0"
 }

@commitlint/config-lerna-scopes/fixtures/nested/packages/c/package.json

@@ -1,5 +1,4 @@
 {
-  "lerna": "4",
   "version": "1.0.0",
-  "packages": ["@packages/*"]
+  "packages": ["@packages/**"]
 }

@commitlint/config-lerna-scopes/fixtures/yarn/@packages/a/package.json renamed to @commitlint/config-lerna-scopes/fixtures/no-packages-declaration/lerna.json

@@ -1,8 +1,4 @@
 {
   "name": "scoped",
-  "version": "1.0.0",
-  "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
-  }
+  "version": "1.0.0"
 }

@commitlint/config-lerna-scopes/fixtures/no-packages-declaration/package.json

@@ -1,70 +1,79 @@
-import {createRequire} from 'module';
-import Path from 'path';
-
-import {globSync} from 'glob';
-import importFrom from 'import-from';
-import semver from 'semver';
-
-const require = createRequire(import.meta.url);
+import path from 'node:path';
+import fs from 'node:fs/promises';
+import fg from 'fast-glob';
 
 export default {
-	utils: {getPackages},
+	utils: {getProjects},
 	rules: {
 		'scope-enum': (ctx) =>
-			getPackages(ctx).then((packages) => [2, 'always', packages]),
+			getProjects(ctx).then((packages) => [2, 'always', packages]),
 	},
 };
 
-function getPackages(context) {
-	return Promise.resolve()
-		.then(() => {
-			const ctx = context || {};
-			const cwd = ctx.cwd || process.cwd();
-
-			const {workspaces} = require(Path.join(cwd, 'package.json'));
-			if (Array.isArray(workspaces) && workspaces.length) {
-				// use yarn workspaces
+/**
+ * Turn glob paths with potential 'package.json' ending always into paths
+ * with a package.json ending to find monorepo packages
+ * @param {string[]} patterns
+ * @returns A list of glob paths to resolve package.json files
+ */
+function normalizePatterns(patterns) {
+	const normalizedPatterns = [];
+	for (const pattern of patterns) {
+		normalizedPatterns.push(pattern.replace(/\/?$/, '/package.json'));
+	}
+	return normalizedPatterns;
+}
 
-				const wsGlobs = workspaces.flatMap((ws) => {
-					const path = Path.posix.join(ws, 'package.json');
-					return globSync(path, {cwd, ignore: ['**/node_modules/**']});
-				});
+/**
+ * Find all package.json contents in the defined cwd
+ * @param {string} cwd
+ * @returns A list of parsed package.json files as objects
+ */
+async function findPackages(cwd) {
+	const json = await fs.readFile(path.join(cwd, 'lerna.json'), {
+		encoding: 'utf-8',
+	});
 
-				return wsGlobs.map((pJson) => require(Path.join(cwd, pJson)));
-			}
+	const packages = JSON.parse(json)?.packages || [];
+	if (packages.length === 0) {
+		console.warn(
+			[
+				`The lerna.json configuration is missing a valid "packages" field. To fix this issue you should either:`,
+				` - define one or more paths within the "packages" field in lerna.json`,
+				` - use the "@commitlint/config-workspace-scopes" plugin if you are using npm/yarn workspaces`,
+			].join('\n')
+		);
+		return [];
+	}
 
-			const lernaVersion = getLernaVersion(cwd);
-			if (semver.lt(lernaVersion, '3.0.0')) {
-				const Repository = importFrom(cwd, 'lerna/lib/Repository');
-				const PackageUtilities = importFrom(cwd, 'lerna/lib/PackageUtilities');
+	const patterns = normalizePatterns(packages);
+	const entries = await fg(patterns, {
+		cwd,
+		ignore: ['**/node_modules/**', '**/bower_components/**'],
+	});
 
-				const repository = new Repository(cwd);
-				return PackageUtilities.getPackages({
-					packageConfigs: repository.packageConfigs,
-					rootPath: cwd,
-				});
-			}
+	const pkgJsons = await Promise.all(
+		Array.from(new Set(entries.map((entry) => path.join(cwd, entry)))).map(
+			(pkgPath) => fs.readFile(pkgPath, {encoding: 'utf-8'})
+		)
+	);
 
-			const {getPackages} = importFrom(cwd, '@lerna/project');
-			return getPackages(cwd);
-		})
-		.then((packages) => {
-			return packages
-				.map((pkg) => pkg.name)
-				.filter(Boolean)
-				.map((name) => (name.charAt(0) === '@' ? name.split('/')[1] : name));
-		});
+	return pkgJsons.map((pkgJson) => JSON.parse(pkgJson) || {});
 }
 
-function getLernaVersion(cwd) {
-	const moduleEntrypoint = require.resolve('lerna', {
-		paths: [cwd],
-	});
-	const moduleDir = Path.join(
-		moduleEntrypoint.slice(0, moduleEntrypoint.lastIndexOf('node_modules')),
-		'node_modules',
-		'lerna'
-	);
-	const modulePackageJson = Path.join(moduleDir, 'package.json');
-	return require(modulePackageJson).version;
+async function getProjects(context) {
+	const ctx = context || {};
+	const cwd = ctx.cwd || process.cwd();
+
+	const packages = await findPackages(cwd);
+
+	return packages
+		.reduce((pkgNames, pkg) => {
+			const name = pkg.name;
+			if (name) {
+				pkgNames.push(name.charAt(0) === '@' ? name.split('/')[1] : name);
+			}
+			return pkgNames;
+		}, [])
+		.sort();
 }

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

@@ -1,4 +1,4 @@
-import {test, expect} from 'vitest';
+import {test, expect, vi} from 'vitest';
 import path from 'path';
 import {fileURLToPath} from 'url';
 
@@ -58,44 +58,48 @@ test('returns empty value for empty lerna repository', async () => {
 	expect(value).toEqual([]);
 });
 
+test('returns all packages for nested lerna packages repository', async () => {
+	const {'scope-enum': fn} = config.rules;
+	const cwd = await npm.bootstrap('fixtures/nested', __dirname);
+	const [, , value] = await fn({cwd});
+	expect(value).toEqual(['nested-a', 'nested-b', 'nested-c']);
+});
+
 test('returns expected value for basic lerna 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']);
+	expect(value).toEqual(['basic-a', 'basic-b']);
 });
 
 test('returns expected value for lerna repository containing modules', async () => {
 	const {'scope-enum': fn} = config.rules;
 	const cwd = await npm.bootstrap('fixtures/modules', __dirname);
 
 	const [, , value] = await fn({cwd});
-	expect(value).toEqual(['a']);
+	expect(value).toEqual(['modules-a']);
 });
 
 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']);
+	expect(value).toEqual(['scoped-a', 'scoped-b']);
 });
 
-test('returns expected value for yarn workspaces', async () => {
+test('shows a warning for missing packages declaration in lerna.json', async () => {
 	const {'scope-enum': fn} = config.rules;
-	const cwd = path.join(__dirname, 'fixtures', 'yarn');
-	const [, , value] = await fn({cwd});
-	expect(value.sort()).toEqual(['a', 'b']);
-});
+	const cwd = await npm.bootstrap(
+		'fixtures/no-packages-declaration',
+		__dirname
+	);
+	const consoleWarnSpy = vi.spyOn(console, 'warn');
 
-test('returns expected value for yarn workspaces has nested packages', async () => {
-	const {'scope-enum': fn} = config.rules;
-	const cwd = await npm.bootstrap('fixtures/nested-workspaces', __dirname);
+	await fn({cwd});
 
-	const [, , value] = await fn({cwd});
-	expect(value).toEqual(expect.arrayContaining(['nested-a', 'nested-b']));
-	expect(value).toEqual(
-		expect.not.arrayContaining(['dependency-a', 'dependency-b'])
+	expect(consoleWarnSpy).toHaveBeenCalledWith(
+		expect.stringContaining(`is missing a valid "packages" field`)
 	);
 });