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

janbiasi · janbiasi · commit 22f09300c249 · 2025-02-16T11:36:30.000+01:00
BREAKING CHANGE: drop support for lerna &lt; 7.1.0
diff --git a/@commitlint/config-lerna-scopes/fixtures/basic/lerna.json b/@commitlint/config-lerna-scopes/fixtures/basic/lerna.json
@@ -1,5 +1,5 @@
 {
-  "lerna": "4",
+  "lerna": "8",
   "version": "1.0.0",
   "packages": ["packages/*"]
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/basic/package.json b/@commitlint/config-lerna-scopes/fixtures/basic/package.json
@@ -2,7 +2,6 @@
   "name": "basic",
   "version": "1.0.0",
   "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
+    "lerna": "^8.1.9"
   }
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/basic/packages/a/package.json b/@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"
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/basic/packages/b/package.json b/@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"
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/empty/lerna.json b/@commitlint/config-lerna-scopes/fixtures/empty/lerna.json
@@ -1,5 +1,5 @@
 {
-  "lerna": "4",
+  "lerna": "8",
   "version": "1.0.0",
   "packages": ["packages/*"]
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/empty/package.json b/@commitlint/config-lerna-scopes/fixtures/empty/package.json
@@ -2,7 +2,7 @@
   "name": "empty",
   "version": "1.0.0",
   "devDependencies": {
-    "lerna": "^4.0.0",
+    "lerna": "^8.1.9",
     "@lerna/project": "^4.0.0"
   }
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/modules/lerna.json b/@commitlint/config-lerna-scopes/fixtures/modules/lerna.json
@@ -1,5 +1,5 @@
 {
-  "lerna": "4",
+  "lerna": "8",
   "version": "1.0.0",
   "packages": ["packages/*"]
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/modules/package.json b/@commitlint/config-lerna-scopes/fixtures/modules/package.json
@@ -2,7 +2,6 @@
   "name": "basic",
   "version": "1.0.0",
   "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
+    "lerna": "^8.1.9"
   }
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/modules/packages/a/package.json b/@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"
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/a/nested-a/package.json b/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/a/nested-a/package.json
@@ -1,4 +1,4 @@
 {
-  "name": "@packages/nested-a",
+  "name": "@commitlint-lerna-scopes/nested-a",
   "version": "1.0.0"
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/b/nested-b/package.json b/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/@packages/b/nested-b/package.json
@@ -1,4 +1,4 @@
 {
-  "name": "@packages/nested-b",
+  "name": "@commitlint-lerna-scopes/nested-b",
   "version": "1.0.0"
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/lerna.json b/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/lerna.json
@@ -0,0 +1,5 @@
+{
+  "lerna": "8",
+  "version": "1.0.0",
+  "packages": ["packages/**"]
+}
diff --git a/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/package.json b/@commitlint/config-lerna-scopes/fixtures/nested-workspaces/package.json
@@ -1,11 +1,7 @@
 {
   "name": "nested-workspaces",
   "version": "1.0.0",
-  "workspaces": [
-    "@packages/**"
-  ],
   "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
+    "lerna": "^8.1.9"
   }
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/scoped/@packages/a/package.json b/@commitlint/config-lerna-scopes/fixtures/scoped/@packages/a/package.json
@@ -1,4 +1,4 @@
 {
-  "name": "@packages/a",
+  "name": "@commitlint-lerna-scopes/scoped-a",
   "version": "1.0.0"
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/scoped/@packages/b/package.json b/@commitlint/config-lerna-scopes/fixtures/scoped/@packages/b/package.json
@@ -1,4 +1,4 @@
 {
-  "name": "@packages/b",
+  "name": "@commitlint-lerna-scopes/scoped-b",
   "version": "1.0.0"
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/scoped/lerna.json b/@commitlint/config-lerna-scopes/fixtures/scoped/lerna.json
@@ -1,5 +1,5 @@
 {
-  "lerna": "4",
+  "lerna": "8",
   "version": "1.0.0",
   "packages": ["@packages/*"]
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/scoped/package.json b/@commitlint/config-lerna-scopes/fixtures/scoped/package.json
@@ -2,7 +2,6 @@
   "name": "scoped",
   "version": "1.0.0",
   "devDependencies": {
-    "lerna": "^4.0.0",
-    "@lerna/project": "^4.0.0"
+    "lerna": "^8.1.9"
   }
 }
diff --git a/@commitlint/config-lerna-scopes/fixtures/yarn/@packages/a/package.json b/@commitlint/config-lerna-scopes/fixtures/yarn/@packages/a/package.json
diff --git a/@commitlint/config-lerna-scopes/fixtures/yarn/@packages/b/package.json b/@commitlint/config-lerna-scopes/fixtures/yarn/@packages/b/package.json
diff --git a/@commitlint/config-lerna-scopes/fixtures/yarn/package.json b/@commitlint/config-lerna-scopes/fixtures/yarn/package.json
diff --git a/@commitlint/config-lerna-scopes/index.js b/@commitlint/config-lerna-scopes/index.js
@@ -1,70 +1,31 @@
-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);
 
 export default {
-	utils: {getPackages},
+	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();
-
-			const {workspaces} = require(Path.join(cwd, 'package.json'));
-			if (Array.isArray(workspaces) && workspaces.length) {
-				// use yarn workspaces
+async function getPackages(context) {
+	const ctx = context || {};
+	const cwd = ctx.cwd || process.cwd();
 
-				const wsGlobs = workspaces.flatMap((ws) => {
-					const path = Path.posix.join(ws, 'package.json');
-					return globSync(path, {cwd, ignore: ['**/node_modules/**']});
-				});
+	// https://lerna.js.org/docs/api-reference/utilities#detectprojects
+	const {detectProjects} = importFrom(cwd, 'lerna/utils');
+	// https://github.com/lerna/lerna/blob/main/libs/core/src/lib/project-graph-with-packages.ts#L14
+	const projectGraph = await detectProjects(cwd);
+	const packages = Object.values(projectGraph.nodes)
+		.map((node) => node.package)
+		.filter(Boolean);
 
-				return wsGlobs.map((pJson) => require(Path.join(cwd, pJson)));
-			}
-
-			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 repository = new Repository(cwd);
-				return PackageUtilities.getPackages({
-					packageConfigs: repository.packageConfigs,
-					rootPath: cwd,
-				});
-			}
-
-			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));
-		});
-}
+	console.log('>>>>>> PACKAGES', packages);
 
-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;
+	return packages
+		.map((pkg) => pkg.name)
+		.filter(Boolean)
+		.map((name) => (name.charAt(0) === '@' ? name.split('/')[1] : name));
 }
diff --git a/@commitlint/config-lerna-scopes/index.test.js b/@commitlint/config-lerna-scopes/index.test.js
@@ -58,12 +58,12 @@ test('returns empty value for empty lerna repository', async () => {
 	expect(value).toEqual([]);
 });
 
-test('returns expected value for basic lerna repository', async () => {
+test.only('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(['a', 'b', 'c']);
 });
 
 test('returns expected value for lerna repository containing modules', async () => {
@@ -81,21 +81,3 @@ test('returns expected value for scoped lerna repository', async () => {
 	const [, , value] = await fn({cwd});
 	expect(value).toEqual(['a', 'b']);
 });
-
-test('returns expected value for yarn workspaces', 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']);
-});
-
-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);
-
-	const [, , value] = await fn({cwd});
-	expect(value).toEqual(expect.arrayContaining(['nested-a', 'nested-b']));
-	expect(value).toEqual(
-		expect.not.arrayContaining(['dependency-a', 'dependency-b'])
-	);
-});
diff --git a/@commitlint/config-lerna-scopes/package.json b/@commitlint/config-lerna-scopes/package.json
@@ -23,13 +23,16 @@
     "lerna"
   ],
   "author": "Mario Nebl <hello@herebecode.com>",
+  "contributors": [
+    "Jan Biasi (https://github.com/janbiasi)"
+  ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/conventional-changelog/commitlint/issues"
   },
   "homepage": "https://commitlint.js.org/",
   "peerDependencies": {
-    "lerna": ">=5 <9"
+    "lerna": ">=7.1.0"
   },
   "peerDependenciesMeta": {
     "lerna": {
@@ -40,15 +43,13 @@
     "node": ">=v18"
   },
   "dependencies": {
-    "@lerna/project": "^6.0.0",
-    "glob": "^10.3.10",
     "import-from": "^4.0.0",
     "semver": "^7.6.0"
   },
   "devDependencies": {
     "@commitlint/test": "^19.5.0",
     "@commitlint/utils": "^19.5.0",
-    "@types/glob": "^8.1.0"
+    "lerna": "^8.1.9"
   },
   "gitHead": "70f7f4688b51774e7ac5e40e896cdaa3f132b2bc"
 }
diff --git a/lerna.json b/lerna.json
@@ -1,6 +1,5 @@
 {
-  "lerna": "4",
+  "lerna": "8",
   "npmClient": "yarn",
-  "useWorkspaces": true,
   "version": "19.7.1"
 }
diff --git a/package.json b/package.json
@@ -100,7 +100,7 @@
     "eslint-plugin-jest": "^28.8.2",
     "globals": "^15.13.0",
     "husky": "^9.1.5",
-    "lerna": "^6.0.0",
+    "lerna": "^8.1.9",
     "lint-staged": "15.4.3",
     "prettier": "^2.8.8",
     "typescript": "^5.2.2",
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "lerna": "4",`
	`2`	`+ "lerna": "8",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"packages": ["packages/*"]`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`	`"name": "basic",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"devDependencies": {`
`5`		`- "lerna": "^4.0.0",`
`6`		`- "@lerna/project": "^4.0.0"`
	`5`	`+ "lerna": "^8.1.9"`
`7`	`6`	`}`
`8`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "name": "a",`
	`2`	`+ "name": "@commitlint-lerna-scopes/basic-a",`
`3`	`3`	`"version": "1.0.0"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "name": "b",`
	`2`	`+ "name": "@commitlint-lerna-scopes/basic-b",`
`3`	`3`	`"version": "1.0.0"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"name": "empty",`
`3`	`3`	`"version": "1.0.0",`
`4`	`4`	`"devDependencies": {`
`5`		`- "lerna": "^4.0.0",`
	`5`	`+ "lerna": "^8.1.9",`
`6`	`6`	`"@lerna/project": "^4.0.0"`
`7`	`7`	`}`
`8`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "name": "a",`
	`2`	`+ "name": "@commitlint-lerna-scopes/modules-a",`
`3`	`3`	`"version": "1.0.0"`
`4`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "name": "@packages/nested-a",`
	`2`	`+ "name": "@commitlint-lerna-scopes/nested-a",`
`3`	`3`	`"version": "1.0.0"`
`4`	`4`	`}`