dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/src/report/metrics.mjs

@@ -13,27 +13,27 @@ import { formatNumber, formatPercentage } from "./utl/index.mjs";
 const METRIC_WIDTH = 5;
 
 function getMetricsFromFolder({
-  name,
-  moduleCount,
-  afferentCouplings,
-  efferentCouplings,
-  instability,
-  experimentalStats,
+	name,
+	moduleCount,
+	afferentCouplings,
+	efferentCouplings,
+	instability,
+	experimentalStats,
 }) {
-  const lReturnValue = {
-    type: "folder",
-    name,
-    moduleCount,
-    afferentCouplings,
-    efferentCouplings,
-    instability,
-  };
-  if (experimentalStats) {
-    lReturnValue.size = experimentalStats.size;
-    lReturnValue.topLevelStatementCount =
-      experimentalStats.topLevelStatementCount;
-  }
-  return lReturnValue;
+	const lReturnValue = {
+		type: "folder",
+		name,
+		moduleCount,
+		afferentCouplings,
+		efferentCouplings,
+		instability,
+	};
+	if (experimentalStats) {
+		lReturnValue.size = experimentalStats.size;
+		lReturnValue.topLevelStatementCount =
+			experimentalStats.topLevelStatementCount;
+	}
+	return lReturnValue;
 }
 
 /**
@@ -42,36 +42,36 @@ function getMetricsFromFolder({
  * @returns
  */
 function getMetricsFromModule({
-  source,
-  dependents,
-  dependencies,
-  instability,
-  experimentalStats,
+	source,
+	dependents,
+	dependencies,
+	instability,
+	experimentalStats,
 }) {
-  const lReturnValue = {
-    type: "module",
-    name: source,
-    moduleCount: 1,
-    afferentCouplings: dependents.length,
-    efferentCouplings: dependencies.length,
-    instability,
-  };
-  if (experimentalStats) {
-    lReturnValue.size = experimentalStats.size;
-    lReturnValue.topLevelStatementCount =
-      experimentalStats.topLevelStatementCount;
-  }
-  return lReturnValue;
+	const lReturnValue = {
+		type: "module",
+		name: source,
+		moduleCount: 1,
+		afferentCouplings: dependents.length,
+		efferentCouplings: dependencies.length,
+		instability,
+	};
+	if (experimentalStats) {
+		lReturnValue.size = experimentalStats.size;
+		lReturnValue.topLevelStatementCount =
+			experimentalStats.topLevelStatementCount;
+	}
+	return lReturnValue;
 }
 
 function metricsAreCalculable(pModule) {
-  return Object.hasOwn(pModule, "instability");
+	return Object.hasOwn(pModule, "instability");
 }
 
 function componentIsCalculable(pComponent) {
-  return (
-    Number.isInteger(pComponent.moduleCount) && pComponent.moduleCount > -1
-  );
+	return (
+		Number.isInteger(pComponent.moduleCount) && pComponent.moduleCount > -1
+	);
 }
 
 /**
@@ -82,100 +82,100 @@ function componentIsCalculable(pComponent) {
  */
 // eslint-disable-next-line max-lines-per-function
 function transformToTableObject(
-  { modules, folders },
-  { smallIntegerWidth, largeIntegerWidth },
+	{ modules, folders },
+	{ smallIntegerWidth, largeIntegerWidth },
 ) {
-  const lReturnValue = {
-    meta: new Map([
-      ["type", { width: 6, title: "type", format: "string" }],
-      ["name", { width: 0, title: "name", format: "string" }],
-      [
-        "moduleCount",
-        {
-          width: smallIntegerWidth,
-          title: "N",
-          format: "integer",
-        },
-      ],
-      [
-        "afferentCouplings",
-        {
-          width: smallIntegerWidth,
-          title: "Ca",
-          format: "integer",
-        },
-      ],
-      [
-        "efferentCouplings",
-        {
-          width: smallIntegerWidth,
-          title: "Ce",
-          format: "integer",
-        },
-      ],
-      [
-        "instability",
-        {
-          width: smallIntegerWidth,
-          title: "I (%)",
-          format: "percent",
-        },
-      ],
-      [
-        "size",
-        {
-          width: largeIntegerWidth,
-          title: "size",
-          format: "integer",
-        },
-      ],
-      [
-        "topLevelStatementCount",
-        {
-          width: smallIntegerWidth,
-          title: "#tls",
-          format: "integer",
-        },
-      ],
-    ]),
-    data: [],
-  };
-  lReturnValue.data = folders
-    .map(getMetricsFromFolder)
-    .concat(modules.filter(metricsAreCalculable).map(getMetricsFromModule))
-    .filter(componentIsCalculable);
+	const lReturnValue = {
+		meta: new Map([
+			["type", { width: 6, title: "type", format: "string" }],
+			["name", { width: 0, title: "name", format: "string" }],
+			[
+				"moduleCount",
+				{
+					width: smallIntegerWidth,
+					title: "N",
+					format: "integer",
+				},
+			],
+			[
+				"afferentCouplings",
+				{
+					width: smallIntegerWidth,
+					title: "Ca",
+					format: "integer",
+				},
+			],
+			[
+				"efferentCouplings",
+				{
+					width: smallIntegerWidth,
+					title: "Ce",
+					format: "integer",
+				},
+			],
+			[
+				"instability",
+				{
+					width: smallIntegerWidth,
+					title: "I (%)",
+					format: "percent",
+				},
+			],
+			[
+				"size",
+				{
+					width: largeIntegerWidth,
+					title: "size",
+					format: "integer",
+				},
+			],
+			[
+				"topLevelStatementCount",
+				{
+					width: smallIntegerWidth,
+					title: "#tls",
+					format: "integer",
+				},
+			],
+		]),
+		data: [],
+	};
+	lReturnValue.data = folders
+		.map(getMetricsFromFolder)
+		.concat(modules.filter(metricsAreCalculable).map(getMetricsFromModule))
+		.filter(componentIsCalculable);
 
-  const lMaxNameWidth = lReturnValue.data
-    .map(({ name }) => name.length)
-    .concat(lReturnValue.meta.get("name").title.length)
-    .sort((pLeft, pRight) => pLeft - pRight)
-    .pop();
-  lReturnValue.meta.get("name").width = lMaxNameWidth;
+	const lMaxNameWidth = lReturnValue.data
+		.map(({ name }) => name.length)
+		.concat(lReturnValue.meta.get("name").title.length)
+		.sort((pLeft, pRight) => pLeft - pRight)
+		.pop();
+	lReturnValue.meta.get("name").width = lMaxNameWidth;
 
-  return lReturnValue;
+	return lReturnValue;
 }
 
 function orderByNumber(pAttributeName) {
-  return (pLeft, pRight) =>
-    // eslint-disable-next-line security/detect-object-injection
-    (pRight[pAttributeName] || 0) - (pLeft[pAttributeName] || 0);
+	return (pLeft, pRight) =>
+		// eslint-disable-next-line security/detect-object-injection
+		(pRight[pAttributeName] || 0) - (pLeft[pAttributeName] || 0);
 }
 
 function orderByString(pAttributeName) {
-  return (pLeft, pRight) =>
-    // eslint-disable-next-line security/detect-object-injection
-    pLeft[pAttributeName].localeCompare(pRight[pAttributeName]);
+	return (pLeft, pRight) =>
+		// eslint-disable-next-line security/detect-object-injection
+		pLeft[pAttributeName].localeCompare(pRight[pAttributeName]);
 }
 /**
  * @param {IMeta} pMetaData
  * @returns {string}
  */
 function formatToTextHeader(pMetaData) {
-  return Array.from(pMetaData.values())
-    .map(({ title, width, format }) =>
-      format === "string" ? title.padEnd(width + 1) : title.padStart(width + 1),
-    )
-    .join(" ");
+	return Array.from(pMetaData.values())
+		.map(({ title, width, format }) =>
+			format === "string" ? title.padEnd(width + 1) : title.padStart(width + 1),
+		)
+		.join(" ");
 }
 
 /**
@@ -183,9 +183,9 @@ function formatToTextHeader(pMetaData) {
  * @returns {string}
  */
 function formatToTextDemarcationLine(pMetaData) {
-  return Array.from(pMetaData.values())
-    .map(({ width }) => "-".repeat(width + 1))
-    .join(" ");
+	return Array.from(pMetaData.values())
+		.map(({ width }) => "-".repeat(width + 1))
+		.join(" ");
 }
 
 /**
@@ -194,28 +194,28 @@ function formatToTextDemarcationLine(pMetaData) {
  * @returns {string}
  */
 function formatToTextData(pData, pMetaData) {
-  return pData
-    .map((pRow) => {
-      return Object.keys(pRow)
-        .map((pKey) => {
-          const lMeta = pMetaData.get(pKey);
-          if (lMeta.format === "string") {
-            // eslint-disable-next-line security/detect-object-injection
-            return pRow[pKey].padEnd(lMeta.width + 1);
-          }
-          if (lMeta.format === "percent") {
-            // eslint-disable-next-line security/detect-object-injection
-            return formatPercentage(pRow[pKey]).padStart(lMeta.width + 1);
-          }
-          // eslint-disable-next-line security/detect-object-injection
-          return Number.isInteger(pRow[pKey])
-            ? // eslint-disable-next-line security/detect-object-injection
-              formatNumber(pRow[pKey]).padStart(lMeta.width + 1)
-            : "".padStart(lMeta.width + 1);
-        })
-        .join(" ");
-    })
-    .join(EOL);
+	return pData
+		.map((pRow) => {
+			return Object.keys(pRow)
+				.map((pKey) => {
+					const lMeta = pMetaData.get(pKey);
+					if (lMeta.format === "string") {
+						// eslint-disable-next-line security/detect-object-injection
+						return pRow[pKey].padEnd(lMeta.width + 1);
+					}
+					if (lMeta.format === "percent") {
+						// eslint-disable-next-line security/detect-object-injection
+						return formatPercentage(pRow[pKey]).padStart(lMeta.width + 1);
+					}
+					// eslint-disable-next-line security/detect-object-injection
+					return Number.isInteger(pRow[pKey])
+						? // eslint-disable-next-line security/detect-object-injection
+							formatNumber(pRow[pKey]).padStart(lMeta.width + 1)
+						: "".padStart(lMeta.width + 1);
+				})
+				.join(" ");
+		})
+		.join(EOL);
 }
 
 /**
@@ -224,11 +224,11 @@ function formatToTextData(pData, pMetaData) {
  * @returns {string}
  */
 function formatToTextTable(pData, pMetaData) {
-  return [styleText("bold", formatToTextHeader(pMetaData))]
-    .concat(formatToTextDemarcationLine(pMetaData))
-    .concat(formatToTextData(pData, pMetaData))
-    .join(EOL)
-    .concat(EOL);
+	return [styleText("bold", formatToTextHeader(pMetaData))]
+		.concat(formatToTextDemarcationLine(pMetaData))
+		.concat(formatToTextData(pData, pMetaData))
+		.join(EOL)
+		.concat(EOL);
 }
 
 /**
@@ -238,26 +238,26 @@ function formatToTextTable(pData, pMetaData) {
  * @returns {string}
  */
 function transformMetricsToTable(
-  { modules, folders },
-  { orderBy, hideFolders, hideModules },
+	{ modules, folders },
+	{ orderBy, hideFolders, hideModules },
 ) {
-  /** @type {ITableObject} */
-  const lObject = transformToTableObject(
-    { modules, folders },
-    {
-      smallIntegerWidth: METRIC_WIDTH,
-      largeIntegerWidth: METRIC_WIDTH + METRIC_WIDTH,
-    },
-  );
-  let lComponents = lObject.data
-    .filter(
-      (pComponent) =>
-        (!hideModules && pComponent.type === "module") ||
-        (!hideFolders && pComponent.type === "folder"),
-    )
-    .sort(orderByString("name"))
-    .sort(orderByNumber(orderBy || "instability"));
-  return formatToTextTable(lComponents, lObject.meta);
+	/** @type {ITableObject} */
+	const lObject = transformToTableObject(
+		{ modules, folders },
+		{
+			smallIntegerWidth: METRIC_WIDTH,
+			largeIntegerWidth: METRIC_WIDTH + METRIC_WIDTH,
+		},
+	);
+	let lComponents = lObject.data
+		.filter(
+			(pComponent) =>
+				(!hideModules && pComponent.type === "module") ||
+				(!hideFolders && pComponent.type === "folder"),
+		)
+		.sort(orderByString("name"))
+		.sort(orderByNumber(orderBy || "instability"));
+	return formatToTextTable(lComponents, lObject.meta);
 }
 
 /**
@@ -271,18 +271,18 @@ function transformMetricsToTable(
  * @return {import('../../types/dependency-cruiser.js').IReporterOutput} -
  */
 export default function metrics(pCruiseResult, pReporterOptions) {
-  const lReporterOptions = pReporterOptions || {};
-  if (pCruiseResult.folders) {
-    return {
-      output: transformMetricsToTable(pCruiseResult, lReporterOptions),
-      exitCode: 0,
-    };
-  } else {
-    return {
-      output:
-        `${EOL}ERROR: The cruise result didn't contain any metrics - re-running the cruise with${EOL}` +
-        `       the '--metrics' command line option should fix that.${EOL}${EOL}`,
-      exitCode: 1,
-    };
-  }
+	const lReporterOptions = pReporterOptions || {};
+	if (pCruiseResult.folders) {
+		return {
+			output: transformMetricsToTable(pCruiseResult, lReporterOptions),
+			exitCode: 0,
+		};
+	} else {
+		return {
+			output:
+				`${EOL}ERROR: The cruise result didn't contain any metrics - re-running the cruise with${EOL}` +
+				`       the '--metrics' command line option should fix that.${EOL}${EOL}`,
+			exitCode: 1,
+		};
+	}
 }

package/src/report/null.mjs

@@ -5,8 +5,8 @@
  * @returns {import("../../types/dependency-cruiser").IReporterOutput}
  */
 export default function nullReporter(pResults) {
-  return {
-    output: "",
-    exitCode: pResults.summary.error,
-  };
+	return {
+		output: "",
+		exitCode: pResults.summary.error,
+	};
 }

package/src/report/plugins.mjs

@@ -1,53 +1,53 @@
 export function isValidPlugin(pPluginFunction) {
-  let lReturnValue = false;
-  /** @type {import('../../types/dependency-cruiser').ICruiseResult} */
-  const lMinimalCruiseResult = {
-    modules: [],
-    summary: {
-      error: 0,
-      info: 0,
-      warn: 0,
-      ignore: 0,
-      totalCruised: 0,
-      violations: [],
-      optionsUsed: {},
-    },
-  };
+	let lReturnValue = false;
+	/** @type {import('../../types/dependency-cruiser').ICruiseResult} */
+	const lMinimalCruiseResult = {
+		modules: [],
+		summary: {
+			error: 0,
+			info: 0,
+			warn: 0,
+			ignore: 0,
+			totalCruised: 0,
+			violations: [],
+			optionsUsed: {},
+		},
+	};
 
-  if (typeof pPluginFunction === "function") {
-    const lTestReportOutput = pPluginFunction(lMinimalCruiseResult);
-    lReturnValue =
-      Object.hasOwn(lTestReportOutput, "output") &&
-      Object.hasOwn(lTestReportOutput, "exitCode") &&
-      typeof lTestReportOutput.exitCode === "number";
-  }
-  return lReturnValue;
+	if (typeof pPluginFunction === "function") {
+		const lTestReportOutput = pPluginFunction(lMinimalCruiseResult);
+		lReturnValue =
+			Object.hasOwn(lTestReportOutput, "output") &&
+			Object.hasOwn(lTestReportOutput, "exitCode") &&
+			typeof lTestReportOutput.exitCode === "number";
+	}
+	return lReturnValue;
 }
 
 async function getPluginReporter(pOutputType) {
-  let lReturnValue = false;
+	let lReturnValue = false;
 
-  try {
-    const lModule = await import(pOutputType);
-    lReturnValue = lModule.default;
-  } catch (pError) {
-    throw new Error(
-      `Could not find reporter plugin '${pOutputType}' (or it isn't valid)`,
-    );
-  }
-  if (!isValidPlugin(lReturnValue)) {
-    throw new Error(`${pOutputType} is not a valid plugin`);
-  }
-  return lReturnValue;
+	try {
+		const lModule = await import(pOutputType);
+		lReturnValue = lModule.default;
+	} catch (pError) {
+		throw new Error(
+			`Could not find reporter plugin '${pOutputType}' (or it isn't valid)`,
+		);
+	}
+	if (!isValidPlugin(lReturnValue)) {
+		throw new Error(`${pOutputType} is not a valid plugin`);
+	}
+	return lReturnValue;
 }
 
 export function getExternalPluginReporter(pOutputType) {
-  const lPluginPatternRE = /^plugin:(?<pluginName>.+)$/;
-  const lPluginMatch = (pOutputType || "").match(lPluginPatternRE);
+	const lPluginPatternRE = /^plugin:(?<pluginName>.+)$/;
+	const lPluginMatch = (pOutputType || "").match(lPluginPatternRE);
 
-  if (lPluginMatch?.groups) {
-    return getPluginReporter(lPluginMatch.groups.pluginName);
-  }
+	if (lPluginMatch?.groups) {
+		return getPluginReporter(lPluginMatch.groups.pluginName);
+	}
 
-  return false;
+	return false;
 }