dependency-cruiser 17.3.2 → 17.3.3-beta-2

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

@@ -11,7 +11,7 @@ import configTemplate from "./config-template.mjs";
  * @returns {string}
  */
 function quote(pString) {
-  return `"${pString}"`;
+	return `"${pString}"`;
 }
 
 /**
@@ -19,10 +19,10 @@ function quote(pString) {
  * @returns {string}
  */
 function extensionsToString(pExtensions) {
-  if (pExtensions) {
-    return `[${pExtensions.map(quote).join(", ")}]`;
-  }
-  return "";
+	if (pExtensions) {
+		return `[${pExtensions.map(quote).join(", ")}]`;
+	}
+	return "";
 }
 
 /**
@@ -30,7 +30,7 @@ function extensionsToString(pExtensions) {
  * @returns {string}
  */
 function buildNotToTestRule(pInitOptions) {
-  const lNotToTestRule = `{
+	const lNotToTestRule = `{
       name: 'not-to-test',
       comment:
         "This module depends on code within a folder that should only contain tests. As tests don't " +
@@ -44,12 +44,12 @@ function buildNotToTestRule(pInitOptions) {
         path: '{{testLocationRE}}'
       }
     },`;
-  return pInitOptions.hasTestsOutsideSource
-    ? lNotToTestRule.replace(
-        /{{testLocationRE}}/g,
-        folderNameArrayToRE(pInitOptions?.testLocation ?? []),
-      )
-    : "";
+	return pInitOptions.hasTestsOutsideSource
+		? lNotToTestRule.replace(
+				/{{testLocationRE}}/g,
+				folderNameArrayToRE(pInitOptions?.testLocation ?? []),
+			)
+		: "";
 }
 
 /**
@@ -57,9 +57,9 @@ function buildNotToTestRule(pInitOptions) {
  * @returns {string}
  */
 function buildTsPreCompilationDepsAttribute(pInitOptions) {
-  return pInitOptions.tsPreCompilationDeps
-    ? "tsPreCompilationDeps: true,"
-    : "// tsPreCompilationDeps: false,";
+	return pInitOptions.tsPreCompilationDeps
+		? "tsPreCompilationDeps: true,"
+		: "// tsPreCompilationDeps: false,";
 }
 
 /**
@@ -68,9 +68,9 @@ function buildTsPreCompilationDepsAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildDetectJSDocumentImportsAttribute(pInitOptions) {
-  return pInitOptions.detectJSDocImports
-    ? "detectJSDocImports: true,"
-    : "// detectJSDocImports: true,";
+	return pInitOptions.detectJSDocImports
+		? "detectJSDocImports: true,"
+		: "// detectJSDocImports: true,";
 }
 
 /**
@@ -79,9 +79,9 @@ function buildDetectJSDocumentImportsAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildDetectProcessBuiltinModuleCalls(pInitOptions) {
-  return pInitOptions.detectProcessBuiltinModuleCalls
-    ? "detectProcessBuiltinModuleCalls: true,"
-    : "// detectProcessBuiltinModuleCalls: true,";
+	return pInitOptions.detectProcessBuiltinModuleCalls
+		? "detectProcessBuiltinModuleCalls: true,"
+		: "// detectProcessBuiltinModuleCalls: true,";
 }
 
 /**
@@ -89,9 +89,9 @@ function buildDetectProcessBuiltinModuleCalls(pInitOptions) {
  * @returns {string}
  */
 function buildCombinedDependenciesAttribute(pInitOptions) {
-  return pInitOptions.combinedDependencies
-    ? "combinedDependencies: true,"
-    : "// combinedDependencies: false,";
+	return pInitOptions.combinedDependencies
+		? "combinedDependencies: true,"
+		: "// combinedDependencies: false,";
 }
 
 /**
@@ -99,17 +99,17 @@ function buildCombinedDependenciesAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildTsOrJsConfigAttribute(pInitOptions) {
-  if (pInitOptions.useTsConfig) {
-    return `tsConfig: {
+	if (pInitOptions.useTsConfig) {
+		return `tsConfig: {
       fileName: '${pInitOptions.tsConfig}'
     },`;
-  }
-  if (pInitOptions.useJsConfig) {
-    return `tsConfig: {
+	}
+	if (pInitOptions.useJsConfig) {
+		return `tsConfig: {
       fileName: '${pInitOptions.jsConfig}'
     },`;
-  }
-  return `// tsConfig: {
+	}
+	return `// tsConfig: {
     //   fileName: 'tsconfig.json'
     // },`;
 }
@@ -119,13 +119,13 @@ function buildTsOrJsConfigAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildWebpackConfigAttribute(pInitOptions) {
-  return pInitOptions.webpackConfig
-    ? `webpackConfig: {
+	return pInitOptions.webpackConfig
+		? `webpackConfig: {
       fileName: '${pInitOptions.webpackConfig}',
       // env: {},
       // arguments: {}
     },`
-    : `// webpackConfig: {
+		: `// webpackConfig: {
     //  fileName: 'webpack.config.js',
     //  env: {},
     //  arguments: {}
@@ -137,11 +137,11 @@ function buildWebpackConfigAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildBabelConfigAttribute(pInitOptions) {
-  return pInitOptions.babelConfig
-    ? `babelConfig: {
+	return pInitOptions.babelConfig
+		? `babelConfig: {
       fileName: '${pInitOptions.babelConfig}'
     },`
-    : `// babelConfig: {
+		: `// babelConfig: {
     //   fileName: '.babelrc',
     // },`;
 }
@@ -151,9 +151,9 @@ function buildBabelConfigAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildExtensionsAttribute(pInitOptions) {
-  return pInitOptions.specifyResolutionExtensions
-    ? `extensions: ${extensionsToString(pInitOptions.resolutionExtensions)},`
-    : `// extensions: [".js", ".jsx", ".ts", ".tsx", ".d.ts"],`;
+	return pInitOptions.specifyResolutionExtensions
+		? `extensions: ${extensionsToString(pInitOptions.resolutionExtensions)},`
+		: `// extensions: [".js", ".jsx", ".ts", ".tsx", ".d.ts"],`;
 }
 
 /**
@@ -161,10 +161,10 @@ function buildExtensionsAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildMainFieldsAttribute(pInitOptions) {
-  if (pInitOptions.isTypeModule) {
-    return `mainFields: ["module", "main", "types", "typings"],`;
-  }
-  return `
+	if (pInitOptions.isTypeModule) {
+		return `mainFields: ["module", "main", "types", "typings"],`;
+	}
+	return `
       // if you migrate to ESM (or are in an ESM environment already) you will want to
       // have "module" in the list of mainFields, like so:
       // mainFields: ["module", "main", "types", "typings"],
@@ -176,8 +176,8 @@ function buildMainFieldsAttribute(pInitOptions) {
  * @returns {string}
  */
 function buildBuiltInModulesAttribute(pInitOptions) {
-  if (pInitOptions.usesBun) {
-    return `
+	if (pInitOptions.usesBun) {
+		return `
     /* List of built-in modules to use on top of the ones node declares.
 
        See https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#builtinmodules-influencing-what-to-consider-built-in--core-modules
@@ -197,8 +197,8 @@ function buildBuiltInModulesAttribute(pInitOptions) {
       ]
     },
 `;
-  }
-  return "";
+	}
+	return "";
 }
 
 /**
@@ -210,50 +210,50 @@ function buildBuiltInModulesAttribute(pInitOptions) {
  * @returns {string} the configuration as a string
  */
 export default function buildConfig(pInitOptions) {
-  return configTemplate
-    .replace(
-      /{{sourceLocationRE}}/g,
-      folderNameArrayToRE(pInitOptions.sourceLocation),
-    )
-    .replace(
-      /{{resolutionExtensionsAsString}}/g,
-      extensionsToString(pInitOptions.resolutionExtensions),
-    )
-    .replace("{{notToTestRule}}", buildNotToTestRule(pInitOptions))
-    .replace(
-      "{{detectJSDocImportsAttribute}}",
-      buildDetectJSDocumentImportsAttribute(pInitOptions),
-    )
-    .replace(
-      "{{detectProcessBuiltinModuleCalls}}",
-      buildDetectProcessBuiltinModuleCalls(pInitOptions),
-    )
-    .replace(
-      "{{tsPreCompilationDepsAttribute}}",
-      buildTsPreCompilationDepsAttribute(pInitOptions),
-    )
-    .replace(
-      "{{combinedDependenciesAttribute}}",
-      buildCombinedDependenciesAttribute(pInitOptions),
-    )
-    .replace(
-      "{{tsOrJsConfigAttribute}}",
-      buildTsOrJsConfigAttribute(pInitOptions),
-    )
-    .replace(
-      "{{webpackConfigAttribute}}",
-      buildWebpackConfigAttribute(pInitOptions),
-    )
-    .replace(
-      "{{babelConfigAttribute}}",
-      buildBabelConfigAttribute(pInitOptions),
-    )
-    .replace(
-      "{{builtInModulesAttribute}}",
-      buildBuiltInModulesAttribute(pInitOptions),
-    )
-    .replace("{{extensionsAttribute}}", buildExtensionsAttribute(pInitOptions))
-    .replace("{{mainFieldsAttribute}}", buildMainFieldsAttribute(pInitOptions))
-    .replace("{{version}}", pInitOptions.version)
-    .replace("{{date}}", pInitOptions.date);
+	return configTemplate
+		.replace(
+			/{{sourceLocationRE}}/g,
+			folderNameArrayToRE(pInitOptions.sourceLocation),
+		)
+		.replace(
+			/{{resolutionExtensionsAsString}}/g,
+			extensionsToString(pInitOptions.resolutionExtensions),
+		)
+		.replace("{{notToTestRule}}", buildNotToTestRule(pInitOptions))
+		.replace(
+			"{{detectJSDocImportsAttribute}}",
+			buildDetectJSDocumentImportsAttribute(pInitOptions),
+		)
+		.replace(
+			"{{detectProcessBuiltinModuleCalls}}",
+			buildDetectProcessBuiltinModuleCalls(pInitOptions),
+		)
+		.replace(
+			"{{tsPreCompilationDepsAttribute}}",
+			buildTsPreCompilationDepsAttribute(pInitOptions),
+		)
+		.replace(
+			"{{combinedDependenciesAttribute}}",
+			buildCombinedDependenciesAttribute(pInitOptions),
+		)
+		.replace(
+			"{{tsOrJsConfigAttribute}}",
+			buildTsOrJsConfigAttribute(pInitOptions),
+		)
+		.replace(
+			"{{webpackConfigAttribute}}",
+			buildWebpackConfigAttribute(pInitOptions),
+		)
+		.replace(
+			"{{babelConfigAttribute}}",
+			buildBabelConfigAttribute(pInitOptions),
+		)
+		.replace(
+			"{{builtInModulesAttribute}}",
+			buildBuiltInModulesAttribute(pInitOptions),
+		)
+		.replace("{{extensionsAttribute}}", buildExtensionsAttribute(pInitOptions))
+		.replace("{{mainFieldsAttribute}}", buildMainFieldsAttribute(pInitOptions))
+		.replace("{{version}}", pInitOptions.version)
+		.replace("{{date}}", pInitOptions.date);
 }

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

@@ -1,9 +1,9 @@
 import {
-  readFileSync,
-  readdirSync,
-  accessSync,
-  statSync,
-  constants,
+	readFileSync,
+	readdirSync,
+	accessSync,
+	statSync,
+	constants,
 } from "node:fs";
 import { join } from "node:path";
 import { DEFAULT_CONFIG_FILE_NAME } from "../defaults.mjs";
@@ -25,7 +25,7 @@ const BABEL_CONFIG_CANDIDATE_PATTERN = /^\.babelrc$|.*babel.*\.json/gi;
  * @throws {SyntaxError} when the manifest's json is invalid
  */
 export function readManifest(pManifestFileName = "./package.json") {
-  return JSON.parse(readFileSync(pManifestFileName, "utf8"));
+	return JSON.parse(readFileSync(pManifestFileName, "utf8"));
 }
 
 /**
@@ -36,42 +36,42 @@ export function readManifest(pManifestFileName = "./package.json") {
  * @returns {boolean}
  */
 export function fileExists(pFile) {
-  try {
-    accessSync(pFile, constants.R_OK);
-  } catch (pError) {
-    return false;
-  }
-  return true;
+	try {
+		accessSync(pFile, constants.R_OK);
+	} catch (pError) {
+		return false;
+	}
+	return true;
 }
 
 /**
  * @returns {boolean}
  */
 function babelIsConfiguredInManifest() {
-  let lReturnValue = false;
-
-  try {
-    // @ts-expect-error defaultly tsc doesn't know about newfangled stuff like hasOwn
-    lReturnValue = Object.hasOwn(readManifest(), "babel");
-  } catch (pError) {
-    // silently ignore - we'll return false anyway then
-  }
-  return lReturnValue;
+	let lReturnValue = false;
+
+	try {
+		// @ts-expect-error defaultly tsc doesn't know about newfangled stuff like hasOwn
+		lReturnValue = Object.hasOwn(readManifest(), "babel");
+	} catch (pError) {
+		// silently ignore - we'll return false anyway then
+	}
+	return lReturnValue;
 }
 
 /**
  * @returns {boolean}
  */
 export function isTypeModule() {
-  let lReturnValue = false;
+	let lReturnValue = false;
 
-  try {
-    lReturnValue = (readManifest()?.type ?? "commonjs") === "module";
-  } catch (pError) {
-    // silently ignore - we'll return false anyway then
-  }
+	try {
+		lReturnValue = (readManifest()?.type ?? "commonjs") === "module";
+	} catch (pError) {
+		// silently ignore - we'll return false anyway then
+	}
 
-  return lReturnValue;
+	return lReturnValue;
 }
 
 /**
@@ -79,9 +79,9 @@ export function isTypeModule() {
  * @returns {string[]} Array of folder names
  */
 function getFolderNames(pFolderName) {
-  return readdirSync(pFolderName, "utf8").filter((pFileName) =>
-    statSync(join(pFolderName, pFileName)).isDirectory(),
-  );
+	return readdirSync(pFolderName, "utf8").filter((pFileName) =>
+		statSync(join(pFolderName, pFileName)).isDirectory(),
+	);
 }
 
 /**
@@ -90,11 +90,11 @@ function getFolderNames(pFolderName) {
  * @returns {string[]}
  */
 function getMatchingFileNames(pPattern, pFolderName = process.cwd()) {
-  return readdirSync(pFolderName, "utf8").filter(
-    (pFileName) =>
-      statSync(join(pFolderName, pFileName)).isFile() &&
-      pFileName.match(pPattern),
-  );
+	return readdirSync(pFolderName, "utf8").filter(
+		(pFileName) =>
+			statSync(join(pFolderName, pFileName)).isFile() &&
+			pFileName.match(pPattern),
+	);
 }
 
 /**
@@ -102,20 +102,20 @@ function getMatchingFileNames(pPattern, pFolderName = process.cwd()) {
  * @returns {boolean}
  */
 export function isLikelyMonoRepo(pFolderNames = getFolderNames(process.cwd())) {
-  return pFolderNames.includes("packages");
+	return pFolderNames.includes("packages");
 }
 
 function getPackageManager(pManifest) {
-  let lReturnValue = "";
-  try {
-    const lManifest = pManifest ?? readManifest();
-    if (Object.hasOwn(lManifest, "packageManager")) {
-      lReturnValue = lManifest.packageManager;
-    }
-  } catch (pError) {
-    // silently ignore - we'll return the empty string anyway then
-  }
-  return lReturnValue;
+	let lReturnValue = "";
+	try {
+		const lManifest = pManifest ?? readManifest();
+		if (Object.hasOwn(lManifest, "packageManager")) {
+			lReturnValue = lManifest.packageManager;
+		}
+	} catch (pError) {
+		// silently ignore - we'll return the empty string anyway then
+	}
+	return lReturnValue;
 }
 
 /**
@@ -123,24 +123,24 @@ function getPackageManager(pManifest) {
  * @returns {boolean}
  */
 export function likelyUsesBun(pManifest) {
-  const bunIsPackageManager = getPackageManager(pManifest).startsWith("bun");
-  return (
-    bunIsPackageManager || fileExists("bun.lockb") || fileExists("bunfig.toml")
-  );
+	const bunIsPackageManager = getPackageManager(pManifest).startsWith("bun");
+	return (
+		bunIsPackageManager || fileExists("bun.lockb") || fileExists("bunfig.toml")
+	);
 }
 
 export function hasTestsWithinSource(pTestLocations, pSourceLocations) {
-  return pTestLocations.every((pTestLocation) =>
-    pSourceLocations.includes(pTestLocation),
-  );
+	return pTestLocations.every((pTestLocation) =>
+		pSourceLocations.includes(pTestLocation),
+	);
 }
 
 export function getFolderCandidates(pCandidateFolderArray) {
-  return (pFolderNames = getFolderNames(process.cwd())) => {
-    return pFolderNames.filter((pFolderName) =>
-      pCandidateFolderArray.includes(pFolderName),
-    );
-  };
+	return (pFolderNames = getFolderNames(process.cwd())) => {
+		return pFolderNames.filter((pFolderName) =>
+			pCandidateFolderArray.includes(pFolderName),
+		);
+	};
 }
 
 /**
@@ -148,52 +148,52 @@ export function getFolderCandidates(pCandidateFolderArray) {
  * @returns {string[]}
  */
 export function toSourceLocationArray(pLocations) {
-  if (!Array.isArray(pLocations)) {
-    return pLocations.split(",").map((pFolder) => pFolder.trim());
-  }
-  return pLocations;
+	if (!Array.isArray(pLocations)) {
+		return pLocations.split(",").map((pFolder) => pFolder.trim());
+	}
+	return pLocations;
 }
 
 /**
  * @returns {string[]}
  */
 function getManifestFilesWithABabelConfig() {
-  return babelIsConfiguredInManifest() ? ["package.json"] : [];
+	return babelIsConfiguredInManifest() ? ["package.json"] : [];
 }
 
 export const getBabelConfigCandidates = () =>
-  getManifestFilesWithABabelConfig().concat(
-    getMatchingFileNames(BABEL_CONFIG_CANDIDATE_PATTERN),
-  );
+	getManifestFilesWithABabelConfig().concat(
+		getMatchingFileNames(BABEL_CONFIG_CANDIDATE_PATTERN),
+	);
 export const hasBabelConfigCandidates = () =>
-  getBabelConfigCandidates().length > 0;
+	getBabelConfigCandidates().length > 0;
 
 export const getTSConfigCandidates = (pFolderName = process.cwd()) =>
-  getMatchingFileNames(TSCONFIG_CANDIDATE_PATTERN, pFolderName);
+	getMatchingFileNames(TSCONFIG_CANDIDATE_PATTERN, pFolderName);
 export const hasTSConfigCandidates = (pFolderName = process.cwd()) =>
-  getTSConfigCandidates(pFolderName).length > 0;
+	getTSConfigCandidates(pFolderName).length > 0;
 export const getJSConfigCandidates = (pFolderName = process.cwd()) =>
-  getMatchingFileNames(JSCONFIG_CANDIDATE_PATTERN, pFolderName);
+	getMatchingFileNames(JSCONFIG_CANDIDATE_PATTERN, pFolderName);
 export const hasJSConfigCandidates = (pFolderName = process.cwd()) =>
-  getJSConfigCandidates(pFolderName).length > 0;
+	getJSConfigCandidates(pFolderName).length > 0;
 
 export const getWebpackConfigCandidates = () =>
-  getMatchingFileNames(WEBPACK_CANDIDATE_PATTERN);
+	getMatchingFileNames(WEBPACK_CANDIDATE_PATTERN);
 export const hasWebpackConfigCandidates = () =>
-  getWebpackConfigCandidates().length > 0;
+	getWebpackConfigCandidates().length > 0;
 
 export const getSourceFolderCandidates = getFolderCandidates(
-  LIKELY_SOURCE_FOLDERS,
+	LIKELY_SOURCE_FOLDERS,
 );
 export const getTestFolderCandidates = getFolderCandidates(LIKELY_TEST_FOLDERS);
 
 export const getMonoRepoPackagesCandidates = getFolderCandidates(
-  LIKELY_PACKAGES_FOLDERS,
+	LIKELY_PACKAGES_FOLDERS,
 );
 
 /**
  * @returns {string}
  */
 export function getDefaultConfigFileName() {
-  return isTypeModule() ? ".dependency-cruiser.cjs" : DEFAULT_CONFIG_FILE_NAME;
+	return isTypeModule() ? ".dependency-cruiser.cjs" : DEFAULT_CONFIG_FILE_NAME;
 }

package/src/cli/init-config/find-extensions.mjs

@@ -9,18 +9,18 @@ import findAllFiles from "#utl/find-all-files.mjs";
  * @param {string} pExtension
  */
 function reduceToCounts(pAll, pExtension) {
-  if (pAll[pExtension]) {
-    pAll[pExtension] += 1;
-  } else {
-    pAll[pExtension] = 1;
-  }
-  return pAll;
+	if (pAll[pExtension]) {
+		pAll[pExtension] += 1;
+	} else {
+		pAll[pExtension] = 1;
+	}
+	return pAll;
 }
 
 function compareByCount(pCountsObject) {
-  return function compare(pLeft, pRight) {
-    return pCountsObject[pRight] - pCountsObject[pLeft];
-  };
+	return function compare(pLeft, pRight) {
+		return pCountsObject[pRight] - pCountsObject[pLeft];
+	};
 }
 
 /**
@@ -29,24 +29,24 @@ function compareByCount(pCountsObject) {
  * @returns {string[]}
  */
 export default function findExtensions(pDirectories, pOptions) {
-  const lOptions = {
-    baseDir: process.cwd(),
-    scannableExtensions,
-    ...pOptions,
-  };
+	const lOptions = {
+		baseDir: process.cwd(),
+		scannableExtensions,
+		...pOptions,
+	};
 
-  const lExtensionsWithCounts = pDirectories
-    .flatMap((pDirectory) =>
-      findAllFiles(pDirectory, {
-        baseDir: lOptions.baseDir,
-        ignoreFileContents: lOptions?.ignoreFileContents,
-      })
-        .map(getExtension)
-        .filter(Boolean),
-    )
-    .reduce(reduceToCounts, {});
+	const lExtensionsWithCounts = pDirectories
+		.flatMap((pDirectory) =>
+			findAllFiles(pDirectory, {
+				baseDir: lOptions.baseDir,
+				ignoreFileContents: lOptions?.ignoreFileContents,
+			})
+				.map(getExtension)
+				.filter(Boolean),
+		)
+		.reduce(reduceToCounts, {});
 
-  return Object.keys(lExtensionsWithCounts)
-    .filter((pExtension) => lOptions.scannableExtensions.includes(pExtension))
-    .sort(compareByCount(lExtensionsWithCounts));
+	return Object.keys(lExtensionsWithCounts)
+		.filter((pExtension) => lOptions.scannableExtensions.includes(pExtension))
+		.sort(compareByCount(lExtensionsWithCounts));
 }