dependency-cruiser 18.6.0 → 18.7.0

package/configs/rules/no-duplicate-dependency-types.cjs

@@ -2,7 +2,7 @@ module.exports = {
 	name: "no-duplicate-dep-types",
 	comment:
 		"Likely this module depends on an external ('npm') package that occurs more " +
-		"than once in your package.json i.e. bot as a devDependencies and in dependencies. " +
+		"than once in your package.json i.e. both as a devDependencies and in dependencies. " +
 		"This will cause maintenance problems later on. If it's intentional, you can " +
 		"disable this rule by adding this override as a rule in the 'forbidden' section " +
 		"of your dependency-cruiser configuration: " +

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dependency-cruiser",
-	"version": "18.6.0",
+	"version": "18.7.0",
 	"description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
 	"keywords": [
 		"static analysis",

package/src/analyze/summarize/index.mjs

@@ -1,4 +1,3 @@
-import { EOL } from "node:os";
 import addRuleSetUsed from "./add-rule-set-used.mjs";
 import summarizeModules from "./summarize-modules.mjs";
 import summarizeFolders from "./summarize-folders.mjs";
@@ -11,6 +10,7 @@ import {
 } from "./get-stats.mjs";
 import { compareViolations } from "#graph-utl/compare.mjs";
 import { getEnvironmentInfo } from "#environment.mjs";
+import { determineEnvironmentIssues } from "./verify-environment.mjs";
 
 /**
  * @import { IOptions, IEnvironmentIssue, ISummary, IModule, IFolder } from "../../../types/cruise-result.mjs"
@@ -18,107 +18,6 @@ import { getEnvironmentInfo } from "#environment.mjs";
  * @import { IStrictCruiseOptions } from "../../../types/strict-options.mjs"
  */
 
-/**
- * @param { IOptions } pOptions
- * @param { IAvailableTranspiler[] } pAvailableTranspilers
- * @returns { boolean }
- */
-function swcIsConsistent(pOptions, pAvailableTranspilers) {
-	const lSWCNeeded = (pOptions?.parser ?? "acorn") === "swc";
-	return lSWCNeeded
-		? pAvailableTranspilers.some(
-				(pTranspiler) => pTranspiler.name === "swc" && pTranspiler.available,
-			)
-		: true;
-}
-
-/**
- * @param { IOptions } pOptions
- * @param { IAvailableTranspiler[] } pAvailableTranspilers
- * @returns { boolean }
- */
-function typescriptIsConsistent(pOptions, pAvailableTranspilers) {
-	const lTypeScriptNeeded =
-		Boolean(pOptions?.tsConfig) ||
-		Boolean(pOptions?.tsPreCompilationDeps) ||
-		Boolean(pOptions?.detectJSDocImports) ||
-		(pOptions?.parser ?? "acorn") === "tsc";
-	return lTypeScriptNeeded
-		? pAvailableTranspilers.some(
-				(pTranspiler) =>
-					pTranspiler.name === "typescript" && pTranspiler.available,
-			)
-		: true;
-}
-/**
- * @param { IOptions } pOptions
- * @param { IAvailableTranspiler[] } pAvailableTranspilers
- * @returns { boolean }
- */
-function babelIsConsistent(pOptions, pAvailableTranspilers) {
-	return Boolean(pOptions?.babelConfig)
-		? pAvailableTranspilers.some(
-				(pTranspiler) => pTranspiler.name === "babel" && pTranspiler.available,
-			)
-		: true;
-}
-
-/**
- * @param {IOptions} pOptions
- * @param {IAvailableTranspiler[]} pAvailableTranspilers
- * @returns {{issues?: IEnvironmentIssue[]}}
- */
-function determineEnvironmentIssues(pOptions, pAvailableTranspilers) {
-	const lIssues = [];
-	if (!typescriptIsConsistent(pOptions, pAvailableTranspilers)) {
-		const tsTranspiler = pAvailableTranspilers.find(
-			(pTranspiler) => pTranspiler.name === "typescript",
-		);
-
-		lIssues.push({
-			severity: "warn",
-			name: "missing-typescript-transpiler",
-			description:
-				`dependency-cruiser detected a TypeScript environment,${EOL}` +
-				`    but not a compatible TypeScript compiler (${tsTranspiler.name}: ${tsTranspiler.version}). This means${EOL}` +
-				`    it's likely to have missed TypeScript sources and dependencies.${EOL}${EOL}` +
-				`    Install typescript to get better results (e.g. npm i -D typescript@^6).${EOL}${EOL}` +
-				`    => Support for typescript@>=7 will follow when its API is published and stable.${EOL}`,
-		});
-	}
-	if (!swcIsConsistent(pOptions, pAvailableTranspilers)) {
-		const swcTranspiler = pAvailableTranspilers.find(
-			(pTranspiler) => pTranspiler.name === "swc",
-		);
-
-		lIssues.push({
-			severity: "warn",
-			name: "missing-swc-transpiler",
-			description:
-				`dependency-cruiser found swc configured as parser, but ${EOL}` +
-				`    it did not find a compatible version of swc (${swcTranspiler.name}: ${swcTranspiler.version}).${EOL}` +
-				`    dependency-cruiser might have missed some sources or dependencies.${EOL}${EOL}` +
-				`    Install swc (e.g. npm i -D @swc/core) to get better results.${EOL}`,
-		});
-	}
-	if (!babelIsConsistent(pOptions, pAvailableTranspilers)) {
-		const babelTranspiler = pAvailableTranspilers.find(
-			(pTranspiler) => pTranspiler.name === "babel",
-		);
-
-		lIssues.push({
-			severity: "warn",
-			name: "missing-babel-transpiler",
-			description:
-				`dependency-cruiser detected a babel configuration, but not a${EOL}` +
-				`    compatible babel transpiler (${babelTranspiler.name}: ${babelTranspiler.version}). If you indeed use babel,${EOL}` +
-				`    dependency-cruiser might have missed some sources or dependencies.${EOL}${EOL}` +
-				`    Install babel (e.g. npm i -D @babel/core@^7) to get better results.${EOL}`,
-		});
-	}
-	return lIssues.length > 0 ? { issues: lIssues } : {};
-}
-
 function getAdvisedExitCode(
 	pErrorCount,
 	pBaselineStaleCount,

package/src/analyze/summarize/verify-environment.mjs

@@ -0,0 +1,146 @@
+import { EOL } from "node:os";
+/**
+ * @import { IOptions, IEnvironmentIssue } from "../../../types/cruise-result.mjs"
+ * @import { IAvailableTranspiler } from "../../../types/environment.mjs"
+ */
+
+/**
+ * @param { IOptions } pOptions
+ * @param { IAvailableTranspiler[] } pAvailableTranspilers
+ * @returns { boolean }
+ */
+function swcIsConsistent(pOptions, pAvailableTranspilers) {
+	const lSWCNeeded = (pOptions?.parser ?? "acorn") === "swc";
+	return lSWCNeeded
+		? pAvailableTranspilers.some(
+				(pTranspiler) => pTranspiler.name === "swc" && pTranspiler.available,
+			)
+		: true;
+}
+
+/**
+ * @param { IOptions } pOptions
+ * @param { IAvailableTranspiler[] } pAvailableTranspilers
+ * @returns { boolean }
+ */
+function tscIsConsistent(pOptions, pAvailableTranspilers) {
+	const lTSCNeeded =
+		Boolean(pOptions?.tsPreCompilationDeps) ||
+		Boolean(pOptions?.detectJSDocImports) ||
+		(pOptions?.parser ?? "acorn") === "tsc";
+	return lTSCNeeded
+		? pAvailableTranspilers.some(
+				(pTranspiler) =>
+					pTranspiler.name === "typescript" && pTranspiler.available,
+			)
+		: true;
+}
+
+function typeScriptIsConsistent(pOptions, pAvailableTranspilers) {
+	const lTypeScriptNeeded =
+		Boolean(pOptions?.tsConfig) &&
+		!(
+			// these two options require tsc (covered in tscIsConsistent), so
+			// to prevent typeScriptIsConsistent from also firing (and printing
+			// two messages) we exclude them here
+			Boolean(pOptions?.tsPreCompilationDeps) ||
+			Boolean(pOptions?.detectJSDocImports)
+		);
+	return lTypeScriptNeeded
+		? pAvailableTranspilers.some(
+				(pTranspiler) =>
+					(pTranspiler.name === "typescript" ||
+						(pTranspiler.name === "swc" && pOptions?.parser === "swc")) &&
+					pTranspiler.available,
+			)
+		: true;
+}
+
+/**
+ * @param { IOptions } pOptions
+ * @param { IAvailableTranspiler[] } pAvailableTranspilers
+ * @returns { boolean }
+ */
+function babelIsConsistent(pOptions, pAvailableTranspilers) {
+	return Boolean(pOptions?.babelConfig)
+		? pAvailableTranspilers.some(
+				(pTranspiler) => pTranspiler.name === "babel" && pTranspiler.available,
+			)
+		: true;
+}
+
+/**
+ * @param {IOptions} pOptions
+ * @param {IAvailableTranspiler[]} pAvailableTranspilers
+ * @returns {{issues?: IEnvironmentIssue[]}}
+ */
+export function determineEnvironmentIssues(pOptions, pAvailableTranspilers) {
+	const lIssues = [];
+	if (!tscIsConsistent(pOptions, pAvailableTranspilers)) {
+		const tsTranspiler = pAvailableTranspilers.find(
+			(pTranspiler) => pTranspiler.name === "typescript",
+		);
+
+		lIssues.push({
+			severity: "warn",
+			name: "missing-tsc-transpiler",
+			description:
+				`dependency-cruiser detected a TypeScript environment,${EOL}` +
+				`    but not a compatible TypeScript compiler (${tsTranspiler.name}: ${tsTranspiler.version}). This means${EOL}` +
+				`    it's likely to have missed TypeScript sources and dependencies.${EOL}${EOL}` +
+				`    Install typescript to get better results (e.g. npm i -D typescript@^6).${EOL}${EOL}` +
+				`    => Support for typescript@>=7 will follow when its API is published and stable.${EOL}`,
+		});
+	}
+	if (!typeScriptIsConsistent(pOptions, pAvailableTranspilers)) {
+		const tsTranspilersString = pAvailableTranspilers
+			.filter(
+				(pTranspiler) =>
+					pTranspiler.name === "typescript" || pTranspiler.name === "swc",
+			)
+			.map((pTranspiler) => `${pTranspiler.name}: ${pTranspiler.version}`)
+			.join(", ");
+		lIssues.push({
+			severity: "warn",
+			name: "missing-typescript-transpiler",
+			description:
+				`dependency-cruiser detected an environment that needs a TypeScript compiler of some sort,${EOL}` +
+				`    but did not find one of the supported ones (${tsTranspilersString}).${EOL}` +
+				`    This means it's likely to have missed TypeScript sources and dependencies.${EOL}${EOL}` +
+				`    Install one of the above for better results.${EOL}${EOL}` +
+				`    => if you choose to use swc don't forget to set the "parser" option to "swc"${EOL}` +
+				`    => Support for typescript@>=7 will follow when its API is published and stable.${EOL}`,
+		});
+	}
+	if (!swcIsConsistent(pOptions, pAvailableTranspilers)) {
+		const swcTranspiler = pAvailableTranspilers.find(
+			(pTranspiler) => pTranspiler.name === "swc",
+		);
+
+		lIssues.push({
+			severity: "warn",
+			name: "missing-swc-transpiler",
+			description:
+				`dependency-cruiser found swc configured as compiler, but ${EOL}` +
+				`    it did not find a compatible version of swc (${swcTranspiler.name}: ${swcTranspiler.version}).${EOL}` +
+				`    dependency-cruiser might have missed some sources or dependencies.${EOL}${EOL}` +
+				`    Install swc (e.g. npm i -D @swc/core) to get better results.${EOL}`,
+		});
+	}
+	if (!babelIsConsistent(pOptions, pAvailableTranspilers)) {
+		const babelTranspiler = pAvailableTranspilers.find(
+			(pTranspiler) => pTranspiler.name === "babel",
+		);
+
+		lIssues.push({
+			severity: "warn",
+			name: "missing-babel-transpiler",
+			description:
+				`dependency-cruiser detected a babel configuration, but not a${EOL}` +
+				`    compatible babel transpiler (${babelTranspiler.name}: ${babelTranspiler.version}). If you indeed use babel,${EOL}` +
+				`    dependency-cruiser might have missed some sources or dependencies.${EOL}${EOL}` +
+				`    Install babel (e.g. npm i -D @babel/core@^7) to get better results.${EOL}`,
+		});
+	}
+	return lIssues.length > 0 ? { issues: lIssues } : {};
+}

package/src/cli/init-config/config-template.mjs

@@ -112,7 +112,7 @@ module.exports = {
       name: 'no-duplicate-dep-types',
       comment:
         "Likely this module depends on an external ('npm') package that occurs more than once " +
-        "in your package.json i.e. bot as a devDependencies and in dependencies. This will cause " +
+        "in your package.json i.e. both as a devDependencies and in dependencies. This will cause " +
         "maintenance problems later on.",
       severity: 'warn',
       from: {},

package/src/extract/resolve/determine-dependency-types.mjs

@@ -22,7 +22,9 @@ function dependencyKeyHasModuleName(
 	pPrefix,
 ) {
 	return (pKey) =>
-		pKey.includes("ependencies") &&
+		// dependencies, devDependencies, peerDependencies, optionalDependencies, bundleDependencies, bundledDependencies.
+		// But not peerDependenciesMeta. Or dependenciesIDoNotWantToTalkabout.
+		pKey.endsWith("ependencies") &&
 		Object.hasOwn(pPackageDependencies[pKey], join(pPrefix, pModuleName));
 }
 

package/src/extract/swc/dependency-visitor.mjs

@@ -123,7 +123,7 @@ function nodeIsTypeOnly(pNode) {
 		return true;
 	}
 	return (
-		pNode?.specifiers.length > 0 &&
+		pNode?.specifiers?.length > 0 &&
 		pNode.specifiers.every((pSpecifier) => pSpecifier.isTypeOnly)
 	);
 }
@@ -144,7 +144,9 @@ export default Visitor
 						module: pNode.source.value,
 						moduleSystem: "es6",
 						exoticallyRequired: false,
-						dependencyTypes: ["export"],
+						dependencyTypes: nodeIsTypeOnly(pNode)
+							? ["export", "type-only"]
+							: ["export"],
 					});
 				}
 			}

package/src/extract/transpile/meta.mjs

@@ -109,7 +109,19 @@ export const EXTENSION2AVAILABLE = new Map([
 ]);
 
 const EXTENSIONS_PER_PARSER = {
-	swc: new Set([".js", ".cjs", ".mjs", ".jsx", ".ts", ".tsx", ".d.ts"]),
+	swc: new Set([
+		".js",
+		".cjs",
+		".mjs",
+		".jsx",
+		".ts",
+		".tsx",
+		".d.ts",
+		".cts",
+		".d.cts",
+		".mts",
+		".d.mts",
+	]),
 	// tsc: [".js", ".cjs", ".mjs", ".jsx", ".ts", ".tsx", ".d.ts"],
 	// acorn: [".js", ".cjs", ".mjs", ".jsx"],
 };

package/src/meta.cjs

@@ -1,6 +1,6 @@
 /* generated - don't edit */
 module.exports = {
-	version: "18.6.0",
+	version: "18.7.0",
 	engines: {
 		node: "^22||^24||>=26",
 	},