dependency-cruiser 18.0.0-beta-1 → 18.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dependency-cruiser",
-	"version": "18.0.0-beta-1",
+	"version": "18.0.0",
 	"description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
 	"keywords": [
 		"static analysis",
@@ -143,13 +143,13 @@
 		"README.md"
 	],
 	"dependencies": {
-		"acorn": "8.16.0",
+		"acorn": "8.17.0",
 		"acorn-jsx": "5.3.2",
 		"acorn-jsx-walk": "2.0.0",
 		"acorn-loose": "8.5.2",
 		"acorn-walk": "8.3.5",
 		"commander": "15.0.0",
-		"enhanced-resolve": "5.22.1",
+		"enhanced-resolve": "5.24.1",
 		"ignore": "7.0.5",
 		"interpret": "3.1.1",
 		"is-installed-globally": "1.0.0",
@@ -158,8 +158,9 @@
 		"prompts": "2.4.2",
 		"rechoir": "0.8.0",
 		"safe-regex": "2.1.1",
-		"semver": "7.8.1",
-		"watskeburt": "5.0.3"
+		"semver": "7.8.5",
+		"tsconfig-paths-webpack-plugin": "4.2.0",
+		"watskeburt": "6.0.0"
 	},
 	"engines": {
 		"node": "^22||^24||>=26"

package/src/config-utl/extract-babel-config.mjs

@@ -1,7 +1,6 @@
 import { readFile } from "node:fs/promises";
 
 import { extname } from "node:path";
-import json5 from "json5";
 import makeAbsolute from "./make-absolute.mjs";
 import tryImport from "#utl/try-import.mjs";
 import meta from "#meta.cjs";
@@ -36,6 +35,7 @@ async function getJSConfig(pBabelConfigFileName) {
 
 async function getJSON5Config(pBabelConfigFileName) {
 	let lReturnValue = {};
+	const { default: json5 } = await import("json5");
 
 	try {
 		lReturnValue = json5.parse(await readFile(pBabelConfigFileName, "utf8"));
@@ -95,7 +95,7 @@ export default async function extractBabelConfig(pBabelConfigFileName) {
 			filename: pBabelConfigFileName,
 		};
 		lReturnValue = {
-			...babel.loadOptions(lConfig),
+			...babel.loadOptionsSync(lConfig),
 			// according to the babel documentation a config parsed & expanded through
 			// loadOptions can be passed to the parser. With some plugins/ presets
 			// this does not seem to be true anymore, though

package/src/config-utl/extract-depcruise-config/index.mjs

@@ -58,7 +58,7 @@ export default async function extractDepcruiseConfig(
 	const lResolvedFileName = resolve(
 		pConfigFileName,
 		pBaseDirectory,
-		normalizeResolveOptions(
+		await normalizeResolveOptions(
 			{
 				extensions: [".js", ".json", ".cjs", ".mjs"],
 			},

package/src/config-utl/extract-depcruise-config/read-config.mjs

@@ -1,6 +1,5 @@
 import { readFile } from "node:fs/promises";
 import { extname } from "node:path";
-import json5 from "json5";
 
 /**
  *
@@ -16,5 +15,6 @@ export default async function readConfig(pAbsolutePathToConfigFile) {
 		);
 		return config;
 	}
+	const { default: json5 } = await import("json5");
 	return json5.parse(await readFile(pAbsolutePathToConfigFile, "utf8"));
 }

package/src/config-utl/extract-known-violations.mjs

@@ -1,5 +1,4 @@
 import { readFile } from "node:fs/promises";
-import json5 from "json5";
 import makeAbsolute from "./make-absolute.mjs";
 
 /**
@@ -53,6 +52,8 @@ function makeForwardCompatible(pKnownViolation) {
 }
 
 export default async function extractKnownViolations(pKnownViolationsFileName) {
+	const { default: json5 } = await import("json5");
+
 	try {
 		const lFileContents = await readFile(
 			makeAbsolute(pKnownViolationsFileName),

package/src/extract/resolve/resolve.mjs

@@ -1,6 +1,6 @@
-import { resolve as resolvePath } from "node:path";
 import enhancedResolve from "enhanced-resolve";
 import { stripQueryParameters } from "../helpers.mjs";
+import pathToPosix from "#utl/path-to-posix.mjs";
 
 /** @import {IResolveOptions} from "../../../types/resolve-options.mjs" */
 
@@ -50,10 +50,8 @@ export function resolve(
 	return stripQueryParameters(
 		gResolvers.get(pCachingContext).resolveSync(
 			{},
-			// lookupStartPath - must be absolute so enhanced-resolve classifies
-			// it correctly on Windows (relative paths with backslashes would be
-			// treated as PathType.Normal and POSIX-normalised, breaking ".." resolution)
-			resolvePath(pFileDirectory),
+			// lookupStartPath
+			pathToPosix(pFileDirectory),
 			// request
 			pModuleName,
 		),

package/src/graph-utl/compare.mjs

@@ -1,3 +1,4 @@
+/** @import { IViolation } from "../../types/dependency-cruiser.mjs" */
 /* eslint-disable no-magic-numbers */
 function severity2number(pSeverity) {
 	const lSeverity2Number = new Map([
@@ -16,6 +17,63 @@ export function compareSeverities(pFirstSeverity, pSecondSeverity) {
 	);
 }
 
+/**
+ * Compare two arrays of mini dependencies by their 'name' field.
+ * Used to deterministically order violations that have the same severity/rule/from/to
+ * but differ in their cycle or via paths.
+ *
+ * @param {Array<{name: string}>} pFirstArray - First array (or undefined)
+ * @param {Array<{name: string}>} pSecondArray - Second array (or undefined)
+ * @returns {number} - -1/0/1 following comparison semantics
+ */
+function compareArraysByName(pFirstArray, pSecondArray) {
+	const lFirst = pFirstArray || [];
+	const lSecond = pSecondArray || [];
+	const lMinLength = Math.min(lFirst.length, lSecond.length);
+
+	// eslint-disable-next-line unicorn/prevent-abbreviations, no-plusplus
+	for (let i = 0; i < lMinLength; i++) {
+		// eslint-disable-next-line security/detect-object-injection
+		const lComparison = lFirst[i].name.localeCompare(lSecond[i].name);
+		if (lComparison !== 0) {
+			return lComparison;
+		}
+	}
+
+	return Math.sign(lFirst.length - lSecond.length);
+}
+
+/**
+ * Compare two arrays of strings.
+ *
+ * @param {Array<string>} pFirstArray - First array (or undefined)
+ * @param {Array<string>} pSecondArray - Second array (or undefined)
+ * @returns {number} - -1/0/1 following comparison semantics
+ */
+function compareArrays(pFirstArray, pSecondArray) {
+	const lFirst = pFirstArray || [];
+	const lSecond = pSecondArray || [];
+	const lMinLength = Math.min(lFirst.length, lSecond.length);
+
+	// eslint-disable-next-line unicorn/prevent-abbreviations, no-plusplus
+	for (let i = 0; i < lMinLength; i++) {
+		// eslint-disable-next-line security/detect-object-injection
+		const lComparison = lFirst[i].localeCompare(lSecond[i]);
+		if (lComparison !== 0) {
+			return lComparison;
+		}
+	}
+
+	return Math.sign(lFirst.length - lSecond.length);
+}
+
+/**
+ *
+ * @param {IViolation} pFirstViolation
+ * @param {IViolation} pSecondViolation
+ * @returns
+ */
+// eslint-disable-next-line complexity
 export function compareViolations(pFirstViolation, pSecondViolation) {
 	return (
 		compareSeverities(
@@ -24,7 +82,17 @@ export function compareViolations(pFirstViolation, pSecondViolation) {
 		) ||
 		pFirstViolation.rule.name.localeCompare(pSecondViolation.rule.name) ||
 		pFirstViolation.from.localeCompare(pSecondViolation.from) ||
-		pFirstViolation.to.localeCompare(pSecondViolation.to)
+		pFirstViolation.to.localeCompare(pSecondViolation.to) ||
+		(pFirstViolation.unresolvedTo ?? "").localeCompare(
+			pSecondViolation.unresolvedTo ?? "",
+		) ||
+		(pFirstViolation.type ?? "").localeCompare(pSecondViolation.type ?? "") ||
+		compareArrays(
+			pFirstViolation.dependencyTypes,
+			pSecondViolation.dependencyTypes,
+		) ||
+		compareArraysByName(pFirstViolation.cycle, pSecondViolation.cycle) ||
+		compareArraysByName(pFirstViolation.via, pSecondViolation.via)
 	);
 }
 

package/src/main/cruise.mjs

@@ -78,7 +78,7 @@ export default async function cruise(
 	);
 
 	bus.summary("startup: get resolve options", c(5));
-	const lNormalizedResolveOptions = normalizeResolveOptions(
+	const lNormalizedResolveOptions = await normalizeResolveOptions(
 		pResolveOptions,
 		lCruiseOptions,
 		pTranspileOptions?.tsConfig,

package/src/main/resolve-options/normalize.mjs

@@ -1,5 +1,4 @@
 import fs from "node:fs";
-import { resolve as resolvePath } from "node:path";
 import enhancedResolve from "enhanced-resolve";
 import { scannableExtensions } from "#extract/transpile/meta.mjs";
 import {
@@ -62,20 +61,64 @@ function getNonOverridableResolveOptions(pCacheDuration) {
 	};
 }
 
-function compileResolveOptions(
+function pushPlugin(pPlugins, pPluginToPush) {
+	return (pPlugins || []).concat(pPluginToPush);
+}
+
+// eslint-disable-next-line max-lines-per-function
+async function compileResolveOptions(
 	pResolveOptions,
 	pTSConfig,
 	pResolveOptionsFromDCConfig,
 ) {
 	let lResolveOptions = {};
 
+	// There's a performance impact of ~1 ms per resolve even when there
+	// are 0 paths in the tsconfig, so not loading it when not necessary
+	// will be a win.
+	// Also: requiring the plugin only when it's necessary will save some
+	// startup time (especially on a cold require cache)
 	if (pResolveOptions.tsConfig) {
-		lResolveOptions.tsconfig = {
-			configFile: resolvePath(pResolveOptions.tsConfig),
-
-			// baseUrl: pTSConfig?.options?.baseUrl ? undefined : "./",
-			// references: pTSConfig?.options?.references ?? []
-		};
+		const { default: TsConfigPathsPlugin } =
+			await import("tsconfig-paths-webpack-plugin");
+		lResolveOptions.plugins = pushPlugin(
+			lResolveOptions.plugins,
+			// @ts-expect-error TS2351 "TsConfPathsPlugin is not constructable" - is unjustified
+			new TsConfigPathsPlugin({
+				configFile: pResolveOptions.tsConfig,
+				// TsConfigPathsPlugin requires a baseUrl to be present in the tsconfig,
+				// otherwise it prints scary messages that it didn't and read the tsConfig
+				// (potentially making users think it's dependency-cruiser disregarding the
+				// tsconfig). Hence up till version 13.0.4 dependency-cruiser only loaded
+				// TsConfigPathsPlugin when an options.baseUrl existed. However, this
+				// isn't necessary anymore:
+				// - [tsconfig#baseUrl documentation](https://www.typescriptlang.org/tsconfig#baseUrl)
+				//   UNrecommends the use of the baseUrl for non-AMD projects
+				// - [tsconfig-paths PR #207](https://github.com/dividab/tsconfig-paths/pull/208)
+				//   'tolerates' undefined baseUrls
+				//
+				// Hence, until
+				// [tpwp issue #99](https://github.com/dividab/tsconfig-paths-webpack-plugin/issues/99)
+				// lands:
+				// - pass a default baseUrl to TsConfigPathsPlugin if the baseUrl isn't available
+				// - pass undefined in all other cases; TsConfigPathsPlugin will read
+				//   it from the tsconfig.json in that case. Passing the processed baseUrl
+				//   (pTSConfig?.options?.baseUrl) instead would've been more obvious, but
+				//   doesn't work, as that is an absolute path and tsconfig-paths(-wpp)
+				//   seems to process that again resulting in invalid paths and unresolved
+				//   or erroneous dependencies
+				// eslint-disable-next-line no-undefined
+				baseUrl: pTSConfig?.options?.baseUrl ? undefined : "./",
+				// TsConfigPathsPlugin doesn't (can't) read enhanced-resolve's
+				// list of extensions, and the default it uses for extensions
+				// so we do it ourselves - either with the extensions passed
+				// or with the supported ones.
+				extensions:
+					pResolveOptionsFromDCConfig.extensions ||
+					pResolveOptions.extensions ||
+					DEFAULT_RESOLVE_OPTIONS.extensions,
+			}),
+		);
 	}
 
 	return {
@@ -97,14 +140,14 @@ function compileResolveOptions(
  * @returns
  */
 // eslint-disable-next-line complexity
-export default function normalizeResolveOptions(
+export default async function normalizeResolveOptions(
 	pResolveOptions,
 	pOptions,
 	pTSConfig,
 ) {
 	const lRuleSet = pOptions?.ruleSet ?? {};
 
-	return compileResolveOptions(
+	return await compileResolveOptions(
 		{
 			// EnhancedResolve's symlinks:
 			// - true => symlinks are followed (vv)

package/src/meta.cjs

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