dependency-cruiser 18.0.0 → 18.1.1

package/configs/plugins/3d-reporter-plugin.mjs

@@ -114,7 +114,7 @@ function render3DThing(pCruiseResult) {
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @returns {import('../../types/dependency-cruiser').IReporterOutput} -
  *      output: a string
  *      exitCode: 0
  */

package/configs/plugins/stats-reporter-plugin.mjs

@@ -34,7 +34,7 @@ function doMagic(pCruiseResult) {
  * got passed
  *
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult - a result from a cruise.
- * @return {string} an object with some stats
+ * @returns {string} an object with some stats
  */
 function samplePluginReporter(pCruiseResult) {
 	const lDependencyCounts = pCruiseResult.modules
@@ -68,7 +68,7 @@ function samplePluginReporter(pCruiseResult) {
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @returns {import('../../types/dependency-cruiser').IReporterOutput} -
  *      output: some stats on modules and dependencies in json format
  *      exitCode: 0
  */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dependency-cruiser",
-	"version": "18.0.0",
+	"version": "18.1.1",
 	"description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
 	"keywords": [
 		"static analysis",
@@ -143,18 +143,18 @@
 		"README.md"
 	],
 	"dependencies": {
-		"acorn": "8.17.0",
+		"acorn": "8.18.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.24.1",
-		"ignore": "7.0.5",
+		"enhanced-resolve": "5.24.5",
+		"ignore": "7.0.6",
 		"interpret": "3.1.1",
 		"is-installed-globally": "1.0.0",
 		"json5": "2.2.3",
-		"picomatch": "4.0.4",
+		"picomatch": "4.0.5",
 		"prompts": "2.4.2",
 		"rechoir": "0.8.0",
 		"safe-regex": "2.1.1",

package/src/analyze/add-validations.mjs

@@ -17,7 +17,7 @@ function addDependencyViolations(pModule, pDependency, pRuleSet, pValidate) {
  * @param  {Partial<import("../../types/cruise-result.mjs").IModule>[]} pModules array of modules
  * @param  {import("../../types/rule-set.mjs").IFlattenedRuleSet} pRuleSet normalized & validated rule set
  * @param {boolean} pValidate - whether or not to validate (typically you want to pass 'true' here)
- * @return {import("../../types/cruise-result.mjs").IModule[]} the same array of modules, with for each
+ * @returns {import("../../types/cruise-result.mjs").IModule[]} the same array of modules, with for each
  *                  of them added whether or not it is
  *                  valid and if not which rules were violated
  */

package/src/analyze/derive/folders/utl.mjs

@@ -23,8 +23,8 @@ export function getEfferentCouplings(pModule, pDirname) {
  * @returns string[]
  */
 export function getParentFolders(pPath) {
-	let lFragments = pPath.split("/");
-	let lReturnValue = [];
+	const lFragments = pPath.split("/");
+	const lReturnValue = [];
 
 	while (lFragments.length > 0) {
 		lReturnValue.push(lFragments.join("/"));

package/src/analyze/summarize/index.mjs

@@ -1,3 +1,4 @@
+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";
@@ -8,31 +9,146 @@ import {
 	getDependenciesCruised,
 } from "./get-stats.mjs";
 import { compareViolations } from "#graph-utl/compare.mjs";
+import { getEnvironmentInfo } from "#environment.mjs";
+
+/**
+ * @import { IOptions, IEnvironmentIssue, ISummary, IModule, IFolder } from "../../../types/cruise-result.mjs"
+ * @import { IAvailableTranspiler } from "../../../types/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 } : {};
+}
 
 /**
  *
- * @param {import("../../../types/cruise-result.mjs").IModule[]} pModules -
+ * @param {IModule[]} pModules -
  *    cruised modules that have been enriched with mandatory attributes &
  *    have been validated against rules as passed in the options
- * @param {import("../../../types/options.mjs").IStrictCruiseOptions} pOptions -
+ * @param {IStrictCruiseOptions} pOptions -
  * @param {string[]} pFileDirectoryArray -
  *    the files/ directories originally passed to be cruised
- * @param {import("../../../types/dependency-cruiser.js").IFolder[]} pFolders -
+ * @param {IFolder[]} pFolders -
  *    the pModules collapsed to folders, with their own metrics & deps
  *
- * @returns {import("../../../types/cruise-result.mjs").ISummary} -
+ * @returns {ISummary} -
  *    a summary of the found modules, dependencies and any violations
  */
+// eslint-disable-next-line max-params
 export default function summarize(
 	pModules,
 	pOptions,
 	pFileDirectoryArray,
 	pFolders,
+	pGetEnvironmentInfoFunction = getEnvironmentInfo,
 ) {
 	const lViolations = summarizeModules(pModules, pOptions.ruleSet)
 		.concat(summarizeFolders(pFolders || [], pOptions.ruleSet))
 		.sort(compareViolations);
 
+	const lEnvironment = pGetEnvironmentInfoFunction();
+	const lEnvironmentWithIssues = {
+		...lEnvironment,
+		...determineEnvironmentIssues(pOptions, lEnvironment.transpilersFound),
+	};
 	return {
 		violations: lViolations,
 		...getViolationStats(lViolations),
@@ -40,5 +156,6 @@ export default function summarize(
 		totalDependenciesCruised: getDependenciesCruised(pModules),
 		...summarizeOptions(pFileDirectoryArray, pOptions),
 		...(pOptions.ruleSet ? { ruleSetUsed: addRuleSetUsed(pOptions) } : {}),
+		environment: lEnvironmentWithIssues,
 	};
 }

package/src/analyze/summarize/summarize-modules.mjs

@@ -69,7 +69,7 @@ function toDependencyViolationSummary(pRule, pModule, pDependency, pRuleSet) {
  *
  * @param {any} pModules an array of modules
  * @param {any} pRuleSet? a rule set
- * @return {any} an array of violations
+ * @returns {any} an array of violations
  */
 function extractDependencyViolations(pModules, pRuleSet) {
 	return pModules

package/src/cache/cache.mjs

@@ -33,7 +33,7 @@ const EMPTY_CACHE = {
 };
 
 // see ./cache-rationales.md#cache-format-versioning for rationale & bump instructions
-const CACHE_FORMAT_VERSION = 16.2;
+const CACHE_FORMAT_VERSION = 18.1;
 
 export default class Cache {
 	/** @type {(IRevisionData | null)=} */
@@ -115,7 +115,7 @@ export default class Cache {
 				lPayload = await readFile(join(pCacheFolder, CACHE_FILE_NAME), "utf8");
 			}
 			return JSON.parse(lPayload);
-		} catch (pError) {
+		} catch {
 			return EMPTY_CACHE;
 		}
 	}
@@ -123,7 +123,7 @@ export default class Cache {
 	/**
 	 * @param {string} pPayload
 	 * @param {boolean} pCompress
-	 * @return {Buffer|string}
+	 * @returns {Buffer|string}
 	 */
 	#compact(pPayload, pCompress) {
 		if (pCompress) {
@@ -144,7 +144,7 @@ export default class Cache {
 	 * @param {IRevisionData=} pRevisionData
 	 */
 	async write(pCacheFolder, pCruiseResult, pRevisionData) {
-		let lRevisionData = pRevisionData ?? this.#revisionData;
+		const lRevisionData = pRevisionData ?? this.#revisionData;
 
 		await mkdir(pCacheFolder, { recursive: true });
 		const lUncompressedPayload = JSON.stringify(
@@ -153,7 +153,7 @@ export default class Cache {
 				lRevisionData,
 			),
 		);
-		let lPayload = this.#compact(lUncompressedPayload, this.#compress);
+		const lPayload = this.#compact(lUncompressedPayload, this.#compress);
 
 		// relying on writeFile defaults to 'do the right thing' (i.e. utf8
 		// when the payload is a string; raw buffer otherwise)

package/src/cache/helpers.mjs

@@ -37,7 +37,7 @@ export function getFileHashSync(pFileName) {
 	let lHashedFileName = "file not found";
 	try {
 		lHashedFileName = hash(readFileSync(pFileName, "utf8"));
-	} catch (pError) {
+	} catch {
 		// will return "file not found" as per default
 	}
 	HASHES_CACHE.set(pFileName, lHashedFileName);
@@ -46,7 +46,7 @@ export function getFileHashSync(pFileName) {
 
 /**
  * @param {IChange} pChange
- * @return {IRevisionChange}
+ * @returns {IRevisionChange}
  */
 export function addCheckSumToChangeSync(pChange) {
 	return {

package/src/cli/format-meta-info.mjs

@@ -1,8 +1,5 @@
-import { release, platform, arch } from "node:os";
 import { styleText } from "node:util";
-
-import { getAvailableTranspilers, allExtensions } from "#main/index.mjs";
-import meta from "#meta.cjs";
+import { getEnvironmentInfo } from "#environment.mjs";
 
 function bool2Symbol(pBool) {
 	return pBool ? styleText("green", "✔") : styleText("red", "x");
@@ -12,13 +9,13 @@ const MAX_VERSION_RANGE_STRING_LENGTH = 19;
 const MAX_TRANSPILER_NAME_LENGTH = 22;
 const MAX_VERSION_STRING_LENGTH = 24;
 
-function formatTranspilers() {
-	let lTranspilerTableHeader = styleText(
+function formatTranspilers(pAvailableTranspilers) {
+	const lTranspilerTableHeader = styleText(
 		"bold",
 		`    ✔ ${"transpiler".padEnd(MAX_TRANSPILER_NAME_LENGTH)} ${"versions supported".padEnd(MAX_VERSION_RANGE_STRING_LENGTH)} version found`,
 	);
-	let lTranspilerTableDivider = `    - ${"-".repeat(MAX_TRANSPILER_NAME_LENGTH)} ${"-".repeat(MAX_VERSION_RANGE_STRING_LENGTH)} ${"-".repeat(MAX_VERSION_STRING_LENGTH)}`;
-	let lTranspilerTable = getAvailableTranspilers()
+	const lTranspilerTableDivider = `    - ${"-".repeat(MAX_TRANSPILER_NAME_LENGTH)} ${"-".repeat(MAX_VERSION_RANGE_STRING_LENGTH)} ${"-".repeat(MAX_VERSION_STRING_LENGTH)}`;
+	const lTranspilerTable = pAvailableTranspilers
 		.map(
 			(pTranspiler) =>
 				`    ${bool2Symbol(pTranspiler.available)} ${pTranspiler.name.padEnd(MAX_TRANSPILER_NAME_LENGTH)} ${pTranspiler.version.padEnd(MAX_VERSION_RANGE_STRING_LENGTH)} ${pTranspiler.currentVersion}`,
@@ -36,12 +33,13 @@ function formatExtensions(pExtensions) {
 }
 
 export default function formatMetaInfo() {
+	const lMetaInfo = getEnvironmentInfo();
 	return `
-    ${styleText("bold", "dependency-cruiser")}@${meta.version}
+    ${styleText("bold", "dependency-cruiser")}@${lMetaInfo.version}
 
-    node version supported : ${meta.engines.node}
-    node version found     : ${process.version}
-    os version found       : ${arch()} ${platform()}@${release()}
+    node version supported : ${lMetaInfo.nodeVersionSupported}
+    node version found     : ${lMetaInfo.nodeVersionFound}
+    os version found       : ${lMetaInfo.osVersionFound}
 
     If you need a supported, but not enabled transpiler ('${styleText(
 			"red",
@@ -50,10 +48,10 @@ export default function formatMetaInfo() {
     it in the same folder dependency-cruiser is installed. E.g. 'npm i livescript'
     will enable livescript support if it's installed in your project folder.
 
-${formatTranspilers()}
+${formatTranspilers(lMetaInfo.transpilersFound)}
     ${styleText("bold", "✔ extension")}
     - ---------
-${formatExtensions(allExtensions)}
+${formatExtensions(lMetaInfo.extensionsFound)}
 `;
 }
 

package/src/cli/index.mjs

@@ -41,7 +41,7 @@ async function addKnownViolations(pCruiseOptions) {
 
 		// Check against json schema is already done in src/main/options/validate
 		// so here we can just concentrate on the io
-		let lCruiseOptions = structuredClone(pCruiseOptions);
+		const lCruiseOptions = structuredClone(pCruiseOptions);
 		set(lCruiseOptions, "ruleSet.options.knownViolations", lKnownViolations);
 		return lCruiseOptions;
 	}
@@ -135,11 +135,10 @@ async function runCruise(pFileDirectoryArray, pCruiseOptions) {
 /**
  *
  * @param {string[]} pFileDirectoryArray
- * @param {import("../../types/options.mjs").ICruiseOptions} lCruiseOptions
+ * @param {import("../../types/options.mjs").ICruiseOptions} pCruiseOptions
  * @param {{stdout: NodeJS.WritableStream, stderr: NodeJS.WritableStream}=} pStreams
  * @returns {number}
  */
-
 // eslint-disable-next-line max-lines-per-function
 export default async function executeCli(
 	pFileDirectoryArray,
@@ -151,7 +150,7 @@ export default async function executeCli(
 		stderr: process.stderr,
 		...(pStreams || {}),
 	};
-	let lCruiseOptions = pCruiseOptions || {};
+	const lCruiseOptions = pCruiseOptions || {};
 	let lExitCode = 0;
 
 	try {

package/src/cli/init-config/check-and-warn-inconsistencies.mjs

@@ -16,7 +16,7 @@ import { getAvailableTranspilers } from "#extract/transpile/meta.mjs";
  *
  * @param {IInitConfig} pInitOptions
  * @param {IAvailableTranspiler[]} pAvailableTranspilers
- * @return {boolean}
+ * @returns {boolean}
  */
 function typescriptIsConsistent(pInitOptions, pAvailableTranspilers) {
 	if (pInitOptions.usesTypeScript) {
@@ -37,7 +37,7 @@ function typescriptIsConsistent(pInitOptions, pAvailableTranspilers) {
  *
  * @param {IInitConfig} pInitOptions
  * @param {IAvailableTranspiler[]} pAvailableTranspilers
- * @return {boolean}
+ * @returns {boolean}
  */
 function babelIsConsistent(pInitOptions, pAvailableTranspilers) {
 	if (pInitOptions.babelConfig) {
@@ -57,7 +57,7 @@ function babelIsConsistent(pInitOptions, pAvailableTranspilers) {
  * @param {IInitConfig} pInitOptions
  * @param {NodeJS.WritableStream} [pErrorStream]
  * @param {typeof getAvailableTranspilers} [pAvailableTranspilerFunction]
- * @return {IInitConfig} pInitOptions
+ * @returns {IInitConfig} pInitOptions
  */
 export function checkAndWarnInconsistencies(
 	pInitOptions,

package/src/cli/init-config/environment-helpers.mjs

@@ -38,7 +38,7 @@ export function readManifest(pManifestFileName = "./package.json") {
 export function fileExists(pFile) {
 	try {
 		accessSync(pFile, constants.R_OK);
-	} catch (pError) {
+	} catch {
 		return false;
 	}
 	return true;
@@ -53,7 +53,7 @@ function babelIsConfiguredInManifest() {
 	try {
 		// @ts-expect-error defaultly tsc doesn't know about newfangled stuff like hasOwn
 		lReturnValue = Object.hasOwn(readManifest(), "babel");
-	} catch (pError) {
+	} catch {
 		// silently ignore - we'll return false anyway then
 	}
 	return lReturnValue;
@@ -67,7 +67,7 @@ export function isTypeModule() {
 
 	try {
 		lReturnValue = (readManifest()?.type ?? "commonjs") === "module";
-	} catch (pError) {
+	} catch {
 		// silently ignore - we'll return false anyway then
 	}
 
@@ -112,7 +112,7 @@ function getPackageManager(pManifest) {
 		if (Object.hasOwn(lManifest, "packageManager")) {
 			lReturnValue = lManifest.packageManager;
 		}
-	} catch (pError) {
+	} catch {
 		// silently ignore - we'll return the empty string anyway then
 	}
 	return lReturnValue;

package/src/cli/init-config/get-user-input.mjs

@@ -163,7 +163,7 @@ const QUESTIONS = [
 ];
 
 /**
- * @return {Promise<import("./types.d.mts").IPartialInitConfig>}
+ * @returns {Promise<import("./types.d.mts").IPartialInitConfig>}
  */
 export default function getUserInput() {
 	return prompts(QUESTIONS);

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

@@ -33,7 +33,7 @@ const PACKAGE_MANIFEST = `./${_PACKAGE_MANIFEST}`;
  * (e.g. a tsconfig exists => use it and assume typescript is used)
  *
  * @param {OneShotConfigIDType} pOneShotConfigId
- * @return {IPartialInitConfig} an initialization configuration
+ * @returns {IPartialInitConfig} an initialization configuration
  */
 function getOneShotConfig(pOneShotConfigId) {
 	/** @type {IPartialInitConfig} */

package/src/cli/init-config/normalize-init-options.mjs

@@ -43,7 +43,7 @@ function getExtensions(pInitOptions) {
 
 /**
  * @param {IPartialInitConfig} pInitOptions
- * @return {IPartialInitConfig}
+ * @returns {IPartialInitConfig}
  */
 function populate(pInitOptions) {
 	const lReturnValue = {
@@ -71,10 +71,10 @@ function populate(pInitOptions) {
 /**
  *
  * @param {IPartialInitConfig} pInitOptions
- * @return {IInitConfig}
+ * @returns {IInitConfig}
  */
 export default function normalizeInitOptions(pInitOptions) {
-	let lReturnValue = populate(pInitOptions);
+	const lReturnValue = populate(pInitOptions);
 	if (!Object.hasOwn(lReturnValue, "hasTestsOutsideSource")) {
 		lReturnValue.hasTestsOutsideSource =
 			!pInitOptions.isMonoRepo &&

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

@@ -7,7 +7,7 @@ export function validateLocation(pLocations) {
 			if (!statSync(lLocation).isDirectory()) {
 				return `'${lLocation}' doesn't seem to be a folder - please try again`;
 			}
-		} catch (pError) {
+		} catch {
 			return `'${lLocation}' doesn't seem to exist - please try again`;
 		}
 	}

package/src/cli/init-config/write-run-scripts-to-manifest.mjs

@@ -60,7 +60,7 @@ const EXPERIMENTAL_SCRIPT_DOC = [
 
 /**
  * @param {import("./types.d.mts").IInitConfig} pInitOptions
- * @return {any} an bunch of key value pairs that can be plonked into a `scripts` attribute in a package.json
+ * @returns {any} an bunch of key value pairs that can be plonked into a `scripts` attribute in a package.json
  */
 export function compileRunScripts(pInitOptions) {
 	let lReturnValue = {};
@@ -91,7 +91,7 @@ export function compileRunScripts(pInitOptions) {
  * @param {any} pAdditionalRunScripts
  * @param {any} pExistingRunScripts
  *
- * @return {any} the scripts in pAdditionalRunScripts that don't yet exist in
+ * @returns {any} the scripts in pAdditionalRunScripts that don't yet exist in
  * pExistingRunScripts
  */
 function filterNewScriptEntries(pExistingRunScripts, pAdditionalRunScripts) {

package/src/cli/listeners/ndjson.mjs

@@ -88,7 +88,7 @@ export default function setUpNDJSONListener(
 	pMaxLevel = INFO,
 	pStream = process.stderr,
 ) {
-	let lState = {
+	const lState = {
 		runStartTime: new Date(Date.now()).toISOString(),
 		runId: randomInt(MIN_RUN_ID, MAX_RUN_ID),
 		previousMessage: "startup: nodejs loading",

package/src/cli/listeners/performance-log/index.mjs

@@ -34,7 +34,7 @@ export default function setUpPerformanceLogListener(
 	pMaxLevel = INFO,
 	pStream = process.stderr,
 ) {
-	let lState = {
+	const lState = {
 		previousMessage: "startup: nodejs loading",
 		previousTime: 0,
 		previousUserUsage: 0,

package/src/cli/normalize-cli-options.mjs

@@ -19,7 +19,7 @@ function getOptionValue(pDefault) {
 
 // eslint-disable-next-line complexity
 function normalizeConfigFileName(pCliOptions, pConfigWrapperName, pDefault) {
-	let lOptions = structuredClone(pCliOptions);
+	const lOptions = structuredClone(pCliOptions);
 
 	if (Object.hasOwn(lOptions, pConfigWrapperName)) {
 		set(
@@ -45,12 +45,13 @@ function fileExists(pFileName) {
 	try {
 		accessSync(pFileName, constants.R_OK);
 		return true;
-	} catch (pError) {
+	} catch {
 		return false;
 	}
 }
 
 function validateAndGetCustomRulesFileName(pValidate) {
+	/* oxlint-disable-next-line no-useless-assignment */
 	let lReturnValue = "";
 
 	if (fileExists(pValidate)) {
@@ -66,7 +67,7 @@ function validateAndGetCustomRulesFileName(pValidate) {
 }
 
 function validateAndGetDefaultRulesFileName() {
-	let lReturnValue = RULES_FILE_NAME_SEARCH_ARRAY.find(fileExists);
+	const lReturnValue = RULES_FILE_NAME_SEARCH_ARRAY.find(fileExists);
 
 	if (typeof lReturnValue === "undefined") {
 		throw new TypeError(
@@ -79,6 +80,7 @@ function validateAndGetDefaultRulesFileName() {
 }
 
 function validateAndNormalizeRulesFileName(pValidate) {
+	/* oxlint-disable-next-line no-useless-assignment */
 	let lReturnValue = "";
 
 	if (typeof pValidate === "string") {
@@ -196,7 +198,7 @@ function normalizeCache(pCliOptions) {
  *
  * @param  {object} pOptionsAsPassedFromCommander [description]
  * @param {any} pKnownCliOptions [description]
- * @return {object}          [description]
+ * @returns {import("../../types/options.mjs").ICruiseOptions}          [description]
  */
 export default async function normalizeOptions(pOptionsAsPassedFromCommander) {
 	let lOptions = {

package/src/cli/utl/assert-file-existence.mjs

@@ -3,7 +3,7 @@ import { accessSync, constants } from "node:fs";
 export default function assertFileExistence(pDirectoryOrFile) {
 	try {
 		accessSync(pDirectoryOrFile, constants.R_OK);
-	} catch (pError) {
+	} catch {
 		throw new Error(
 			`Can't open '${pDirectoryOrFile}' for reading. Does it exist?\n`,
 		);

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

@@ -6,6 +6,7 @@ import tryImport from "#utl/try-import.mjs";
 import meta from "#meta.cjs";
 
 async function getJSConfig(pBabelConfigFileName) {
+	/* oxlint-disable-next-line no-useless-assignment */
 	let lReturnValue = {};
 
 	try {
@@ -34,6 +35,7 @@ async function getJSConfig(pBabelConfigFileName) {
 }
 
 async function getJSON5Config(pBabelConfigFileName) {
+	/* oxlint-disable-next-line no-useless-assignment */
 	let lReturnValue = {};
 	const { default: json5 } = await import("json5");
 
@@ -78,7 +80,7 @@ async function getConfig(pBabelConfigFileName) {
  * Silently fails if a supported @babel/core version can't be found
  *
  * @param {string} pBabelConfigFileName
- * @return {object} babel config as an object
+ * @returns {object} babel config as an object
  * @throws {Error} when the babel config has an unknown extension OR
  *                 when the babel config is invalid OR
  *                 when dependency-cruiser can't yet process it

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

@@ -47,7 +47,7 @@ async function processExtends(pReturnValue, pAlreadyVisited, pBaseDirectory) {
  * @param {string} pConfigFileName
  * @param {Set?} pAlreadyVisited
  * @param {string?} pBaseDirectory
- * @return {import('../../../types/configuration.mjs').IConfiguration} dependency-cruiser options
+ * @returns {import('../../../types/configuration.mjs').IConfiguration} dependency-cruiser options
  * @throws {Error} when the config is not valid (/ does not exist/ isn't readable)
  */
 export default async function extractDepcruiseConfig(