dependency-cruiser 17.3.2 → 17.3.3-beta-2

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

@@ -59,21 +59,21 @@ const TEMPLATE = `
 </html>`;
 
 function deriveGroup(pFileName) {
-  let lReturnValue = "unknown";
-  const lGroupPositionInRe = 2;
-  const lMatch = path.dirname(pFileName).match(/^([^/]+)\/([^/]+)/);
-  if (lMatch) {
-    // eslint-disable-next-line security/detect-object-injection
-    lReturnValue = lMatch[lGroupPositionInRe];
-  }
-  return lReturnValue;
+	let lReturnValue = "unknown";
+	const lGroupPositionInRe = 2;
+	const lMatch = path.dirname(pFileName).match(/^([^/]+)\/([^/]+)/);
+	if (lMatch) {
+		// eslint-disable-next-line security/detect-object-injection
+		lReturnValue = lMatch[lGroupPositionInRe];
+	}
+	return lReturnValue;
 }
 
 function formatFileName(pFileName) {
-  return `${path.dirname(pFileName)}/<b>${path.basename(pFileName)}</b>`;
+	return `${path.dirname(pFileName)}/<b>${path.basename(pFileName)}</b>`;
 }
 function formatDependency(pFrom, pTo) {
-  return `${formatFileName(pFrom)} →</br>${formatFileName(pTo)}`;
+	return `${formatFileName(pFrom)} →</br>${formatFileName(pTo)}`;
 }
 
 /**
@@ -81,31 +81,31 @@ function formatDependency(pFrom, pTo) {
  * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
  */
 function render3DThing(pCruiseResult) {
-  const lNodes = pCruiseResult.modules.map((pModule) => {
-    return {
-      id: pModule.source,
-      displayname: path.basename(pModule.source),
-      dirname: path.dirname(pModule.source),
-      label: formatFileName(pModule.source),
-      group: deriveGroup(pModule.source),
-    };
-  });
-  const lLinks = pCruiseResult.modules.reduce(
-    (pAll, pCurrentModule) =>
-      pAll.concat(
-        pCurrentModule.dependencies.map((pDependency) => ({
-          source: pCurrentModule.source,
-          target: pDependency.resolved,
-          label: formatDependency(pCurrentModule.source, pDependency.resolved),
-        })),
-      ),
-    [],
-  );
+	const lNodes = pCruiseResult.modules.map((pModule) => {
+		return {
+			id: pModule.source,
+			displayname: path.basename(pModule.source),
+			dirname: path.dirname(pModule.source),
+			label: formatFileName(pModule.source),
+			group: deriveGroup(pModule.source),
+		};
+	});
+	const lLinks = pCruiseResult.modules.reduce(
+		(pAll, pCurrentModule) =>
+			pAll.concat(
+				pCurrentModule.dependencies.map((pDependency) => ({
+					source: pCurrentModule.source,
+					target: pDependency.resolved,
+					label: formatDependency(pCurrentModule.source, pDependency.resolved),
+				})),
+			),
+		[],
+	);
 
-  return TEMPLATE.replace(/@@NODES@@/g, JSON.stringify(lNodes)).replace(
-    /@@LINKS@@/g,
-    JSON.stringify(lLinks),
-  );
+	return TEMPLATE.replace(/@@NODES@@/g, JSON.stringify(lNodes)).replace(
+		/@@LINKS@@/g,
+		JSON.stringify(lLinks),
+	);
 }
 
 /**
@@ -119,6 +119,6 @@ function render3DThing(pCruiseResult) {
  *      exitCode: 0
  */
 export default (pCruiseResult) => ({
-  output: render3DThing(pCruiseResult),
-  exitCode: 0,
+	output: render3DThing(pCruiseResult),
+	exitCode: 0,
 });

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

@@ -3,31 +3,31 @@ const P75 = 0.75;
 const DEFAULT_JSON_INDENT = 2;
 
 function doMagic(pCruiseResult) {
-  let lReturnValue = {};
+	let lReturnValue = {};
 
-  if (pCruiseResult.modules.some((pModule) => pModule.dependents)) {
-    const lDependentCounts = pCruiseResult.modules
-      .map((pModule) => pModule.dependents.length)
-      .sort();
+	if (pCruiseResult.modules.some((pModule) => pModule.dependents)) {
+		const lDependentCounts = pCruiseResult.modules
+			.map((pModule) => pModule.dependents.length)
+			.sort();
 
-    lReturnValue = {
-      minDependentsPerModule: lDependentCounts[0] || 0,
-      maxDependentsPerModule:
-        lDependentCounts[Math.max(lDependentCounts.length - 1, 0)] || 0,
-      meanDependentsPerModule:
-        lDependentCounts.reduce((pAll, pCurrent) => pAll + pCurrent, 0) /
-        pCruiseResult.summary.totalCruised,
-      medianDependentsPerModule:
-        lDependentCounts[
-          Math.max(0, Math.floor(lDependentCounts.length * MEDIAN))
-        ],
-      p75DependentsPerModule:
-        lDependentCounts[
-          Math.max(0, Math.floor(lDependentCounts.length * P75))
-        ],
-    };
-  }
-  return lReturnValue;
+		lReturnValue = {
+			minDependentsPerModule: lDependentCounts[0] || 0,
+			maxDependentsPerModule:
+				lDependentCounts[Math.max(lDependentCounts.length - 1, 0)] || 0,
+			meanDependentsPerModule:
+				lDependentCounts.reduce((pAll, pCurrent) => pAll + pCurrent, 0) /
+				pCruiseResult.summary.totalCruised,
+			medianDependentsPerModule:
+				lDependentCounts[
+					Math.max(0, Math.floor(lDependentCounts.length * MEDIAN))
+				],
+			p75DependentsPerModule:
+				lDependentCounts[
+					Math.max(0, Math.floor(lDependentCounts.length * P75))
+				],
+		};
+	}
+	return lReturnValue;
 }
 /**
  * returns an object with some stats from the ICruiseResult pCruiseResult it
@@ -37,29 +37,29 @@ function doMagic(pCruiseResult) {
  * @return {string} an object with some stats
  */
 function samplePluginReporter(pCruiseResult) {
-  const lDependencyCounts = pCruiseResult.modules
-    .map((pModule) => pModule.dependencies.length)
-    .sort();
+	const lDependencyCounts = pCruiseResult.modules
+		.map((pModule) => pModule.dependencies.length)
+		.sort();
 
-  return {
-    moduleCount: pCruiseResult.summary.totalCruised,
-    dependencyCount: pCruiseResult.summary.totalDependenciesCruised,
-    minDependenciesPerModule: lDependencyCounts[0] || 0,
-    maxDependenciesPerModule:
-      lDependencyCounts[Math.max(lDependencyCounts.length - 1, 0)] || 0,
-    meanDependenciesPerModule:
-      pCruiseResult.summary.totalDependenciesCruised /
-      pCruiseResult.summary.totalCruised,
-    medianDependenciesPerModule:
-      lDependencyCounts[
-        Math.max(0, Math.floor(lDependencyCounts.length * MEDIAN))
-      ],
-    p75DependenciesPerModule:
-      lDependencyCounts[
-        Math.max(0, Math.floor(lDependencyCounts.length * P75))
-      ],
-    ...doMagic(pCruiseResult),
-  };
+	return {
+		moduleCount: pCruiseResult.summary.totalCruised,
+		dependencyCount: pCruiseResult.summary.totalDependenciesCruised,
+		minDependenciesPerModule: lDependencyCounts[0] || 0,
+		maxDependenciesPerModule:
+			lDependencyCounts[Math.max(lDependencyCounts.length - 1, 0)] || 0,
+		meanDependenciesPerModule:
+			pCruiseResult.summary.totalDependenciesCruised /
+			pCruiseResult.summary.totalCruised,
+		medianDependenciesPerModule:
+			lDependencyCounts[
+				Math.max(0, Math.floor(lDependencyCounts.length * MEDIAN))
+			],
+		p75DependenciesPerModule:
+			lDependencyCounts[
+				Math.max(0, Math.floor(lDependencyCounts.length * P75))
+			],
+		...doMagic(pCruiseResult),
+	};
 }
 
 /**
@@ -73,10 +73,10 @@ function samplePluginReporter(pCruiseResult) {
  *      exitCode: 0
  */
 export default (pCruiseResult) => ({
-  output: JSON.stringify(
-    samplePluginReporter(pCruiseResult),
-    null,
-    DEFAULT_JSON_INDENT,
-  ),
-  exitCode: 0,
+	output: JSON.stringify(
+		samplePluginReporter(pCruiseResult),
+		null,
+		DEFAULT_JSON_INDENT,
+	),
+	exitCode: 0,
 });

package/configs/recommended-strict.cjs

@@ -1,9 +1,9 @@
 const recommended = require("./recommended.cjs");
 
 module.exports = {
-  ...recommended,
-  forbidden: recommended.forbidden.map((pRule) => {
-    pRule.severity = "error";
-    return pRule;
-  }),
+	...recommended,
+	forbidden: recommended.forbidden.map((pRule) => {
+		pRule.severity = "error";
+		return pRule;
+	}),
 };

package/configs/recommended-warn-only.cjs

@@ -1,9 +1,9 @@
 const recommended = require("./recommended.cjs");
 
 module.exports = {
-  ...recommended,
-  forbidden: recommended.forbidden.map((pRule) => {
-    pRule.severity = "warn";
-    return pRule;
-  }),
+	...recommended,
+	forbidden: recommended.forbidden.map((pRule) => {
+		pRule.severity = "warn";
+		return pRule;
+	}),
 };

package/configs/recommended.cjs

@@ -7,26 +7,26 @@ const notToDeprecated = require("./rules/not-to-deprecated.cjs");
 const notToUnresolvable = require("./rules/not-to-unresolvable.cjs");
 
 module.exports = {
-  forbidden: [
-    noOrphans,
-    noCircular,
-    noDeprecatedCore,
-    noDuplicateDependencyTypes,
-    noNonPackageJson,
-    notToDeprecated,
-    notToUnresolvable,
-  ],
-  options: {
-    doNotFollow: {
-      path: "node_modules",
-      dependencyTypes: [
-        "npm",
-        "npm-dev",
-        "npm-optional",
-        "npm-peer",
-        "npm-bundled",
-        "npm-no-pkg",
-      ],
-    },
-  },
+	forbidden: [
+		noOrphans,
+		noCircular,
+		noDeprecatedCore,
+		noDuplicateDependencyTypes,
+		noNonPackageJson,
+		notToDeprecated,
+		notToUnresolvable,
+	],
+	options: {
+		doNotFollow: {
+			path: "node_modules",
+			dependencyTypes: [
+				"npm",
+				"npm-dev",
+				"npm-optional",
+				"npm-peer",
+				"npm-bundled",
+				"npm-no-pkg",
+			],
+		},
+	},
 };

package/configs/rules/no-circular.cjs

@@ -1,12 +1,12 @@
 module.exports = {
-  name: "no-circular",
-  comment:
-    "This dependency is part of a circular relationship. You might want to revise " +
-    "your solution (i.e. use dependency inversion, make sure the modules have a " +
-    "single responsibility) ",
-  severity: "error",
-  from: {},
-  to: {
-    circular: true,
-  },
+	name: "no-circular",
+	comment:
+		"This dependency is part of a circular relationship. You might want to revise " +
+		"your solution (i.e. use dependency inversion, make sure the modules have a " +
+		"single responsibility) ",
+	severity: "error",
+	from: {},
+	to: {
+		circular: true,
+	},
 };

package/configs/rules/no-deprecated-core.cjs

@@ -1,12 +1,12 @@
 module.exports = {
-  name: "no-deprecated-core",
-  comment:
-    "This module depends on a node core module that has been deprecated. Find an " +
-    "alternative - these are bound to exist - node doesn't deprecate lightly.",
-  severity: "error",
-  from: {},
-  to: {
-    dependencyTypes: ["core"],
-    path: "^(?:punycode|domain|constants|sys|_linklist|_stream_wrap)$",
-  },
+	name: "no-deprecated-core",
+	comment:
+		"This module depends on a node core module that has been deprecated. Find an " +
+		"alternative - these are bound to exist - node doesn't deprecate lightly.",
+	severity: "error",
+	from: {},
+	to: {
+		dependencyTypes: ["core"],
+		path: "^(?:punycode|domain|constants|sys|_linklist|_stream_wrap)$",
+	},
 };

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

@@ -1,19 +1,19 @@
 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 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: " +
-    '{"name": "no-duplicate-dep-types", "severity": "ignore"}',
-  severity: "warn",
-  from: {},
-  to: {
-    moreThanOneDependencyType: true,
-    // as it's pretty common to have a type import be a type only import
-    // _and_ (e.g.) a devDependency - don't consider type-only dependency
-    // types for this rule
-    dependencyTypesNot: ["type-only"],
-  },
+	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 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: " +
+		'{"name": "no-duplicate-dep-types", "severity": "ignore"}',
+	severity: "warn",
+	from: {},
+	to: {
+		moreThanOneDependencyType: true,
+		// as it's pretty common to have a type import be a type only import
+		// _and_ (e.g.) a devDependency - don't consider type-only dependency
+		// types for this rule
+		dependencyTypesNot: ["type-only"],
+	},
 };

package/configs/rules/no-non-package-json.cjs

@@ -1,13 +1,13 @@
 module.exports = {
-  name: "no-non-package-json",
-  severity: "error",
-  comment:
-    "This module depends on an npm package that isn't in the 'dependencies' section " +
-    "of your package.json. That's problematic as the package either (1) won't be " +
-    "available on live (2 - worse) will be available on live with an non-guaranteed " +
-    "version. Fix it by adding the package to the dependencies in your package.json.",
-  from: {},
-  to: {
-    dependencyTypes: ["npm-no-pkg", "npm-unknown"],
-  },
+	name: "no-non-package-json",
+	severity: "error",
+	comment:
+		"This module depends on an npm package that isn't in the 'dependencies' section " +
+		"of your package.json. That's problematic as the package either (1) won't be " +
+		"available on live (2 - worse) will be available on live with an non-guaranteed " +
+		"version. Fix it by adding the package to the dependencies in your package.json.",
+	from: {},
+	to: {
+		dependencyTypes: ["npm-no-pkg", "npm-unknown"],
+	},
 };

package/configs/rules/no-orphans.cjs

@@ -2,27 +2,27 @@ const DOT_FILE_PATTERN = "(^|/)\\.[^/]+\\.(js|cjs|mjs|ts|json)$";
 const TS_DECLARATION_FILE_PATTERN = "\\.d\\.(c|m)?ts$";
 const TS_CONFIG_FILE_PATTERN = "(^|/)tsconfig\\.json$";
 const OTHER_CONFIG_FILES_PATTERN =
-  "(^|/)(?:babel|webpack)\\.config\\.(?:js|cjs|mjs|ts|json)$";
+	"(^|/)(?:babel|webpack)\\.config\\.(?:js|cjs|mjs|ts|json)$";
 
 const KNOWN_CONFIG_FILE_PATTERNS = [
-  DOT_FILE_PATTERN,
-  TS_DECLARATION_FILE_PATTERN,
-  TS_CONFIG_FILE_PATTERN,
-  OTHER_CONFIG_FILES_PATTERN,
+	DOT_FILE_PATTERN,
+	TS_DECLARATION_FILE_PATTERN,
+	TS_CONFIG_FILE_PATTERN,
+	OTHER_CONFIG_FILES_PATTERN,
 ].join("|");
 
 module.exports = {
-  name: "no-orphans",
-  comment:
-    "This is an orphan module - it's likely not used (anymore?). Either use it or " +
-    "remove it. If it's logical this module is an orphan (i.e. it's a config file), " +
-    "add an exception for it in your dependency-cruiser configuration. By default " +
-    "this rule does not scrutinize dotfiles (e.g. .eslintrc.js), TypeScript declaration " +
-    "files (.d.ts/ .d.cts/ .d.mts), tsconfig.json and some of the babel and webpack configs.",
-  severity: "warn",
-  from: {
-    orphan: true,
-    pathNot: KNOWN_CONFIG_FILE_PATTERNS,
-  },
-  to: {},
+	name: "no-orphans",
+	comment:
+		"This is an orphan module - it's likely not used (anymore?). Either use it or " +
+		"remove it. If it's logical this module is an orphan (i.e. it's a config file), " +
+		"add an exception for it in your dependency-cruiser configuration. By default " +
+		"this rule does not scrutinize dotfiles (e.g. .eslintrc.js), TypeScript declaration " +
+		"files (.d.ts/ .d.cts/ .d.mts), tsconfig.json and some of the babel and webpack configs.",
+	severity: "warn",
+	from: {
+		orphan: true,
+		pathNot: KNOWN_CONFIG_FILE_PATTERNS,
+	},
+	to: {},
 };

package/configs/rules/not-to-deprecated.cjs

@@ -1,12 +1,12 @@
 module.exports = {
-  name: "not-to-deprecated",
-  comment:
-    "This module uses a (version of an) npm module that has been deprecated. Either " +
-    "upgrade to a later version of that module, or find an alternative. Deprecated " +
-    "modules are a security risk.",
-  severity: "warn",
-  from: {},
-  to: {
-    dependencyTypes: ["deprecated"],
-  },
+	name: "not-to-deprecated",
+	comment:
+		"This module uses a (version of an) npm module that has been deprecated. Either " +
+		"upgrade to a later version of that module, or find an alternative. Deprecated " +
+		"modules are a security risk.",
+	severity: "warn",
+	from: {},
+	to: {
+		dependencyTypes: ["deprecated"],
+	},
 };

package/configs/rules/not-to-unresolvable.cjs

@@ -1,12 +1,12 @@
 module.exports = {
-  name: "not-to-unresolvable",
-  comment:
-    "This module depends on a module that cannot be found ('resolved to disk'). " +
-    "If it's an npm module: add it to your package.json. In all other cases you " +
-    "likely already know what to do.",
-  severity: "error",
-  from: {},
-  to: {
-    couldNotResolve: true,
-  },
+	name: "not-to-unresolvable",
+	comment:
+		"This module depends on a module that cannot be found ('resolved to disk'). " +
+		"If it's an npm module: add it to your package.json. In all other cases you " +
+		"likely already know what to do.",
+	severity: "error",
+	from: {},
+	to: {
+		couldNotResolve: true,
+	},
 };