dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/src/report/error-html/index.mjs

@@ -1,24 +1,24 @@
 import {
-  determineFromExtras,
-  aggregateViolations,
-  determineTo,
+	determineFromExtras,
+	aggregateViolations,
+	determineTo,
 } from "./utl.mjs";
 import template from "./error-html-template.mjs";
 import meta from "#meta.cjs";
 
 function getViolatedRuleRowClass(pViolatedRule) {
-  return pViolatedRule.unviolated ? ' class="unviolated"' : "";
+	return pViolatedRule.unviolated ? ' class="unviolated"' : "";
 }
 
 function getViolatedRuleOkNokCell(pViolatedRule) {
-  if (pViolatedRule.unviolated) {
-    return '<span class="ok">&check;</span>';
-  }
-  return `<span class="${pViolatedRule.severity}">&cross;</span>`;
+	if (pViolatedRule.unviolated) {
+		return '<span class="ok">&check;</span>';
+	}
+	return `<span class="${pViolatedRule.severity}">&cross;</span>`;
 }
 
 function buildViolatedRuleRow(pViolatedRule) {
-  return `<tr${getViolatedRuleRowClass(pViolatedRule)}>
+	return `<tr${getViolatedRuleRowClass(pViolatedRule)}>
     <td>${getViolatedRuleOkNokCell(pViolatedRule)}</td>
     <td>${pViolatedRule.severity}</td>
     <td class="nowrap">
@@ -37,7 +37,7 @@ function buildViolatedRuleRow(pViolatedRule) {
  * @returns {string}
  */
 function constructViolatedRulesTable(pResults) {
-  return `<table>
+	return `<table>
     <tbody>
       <thead>
         <tr>
@@ -50,11 +50,11 @@ function constructViolatedRulesTable(pResults) {
         </tr>
       </thead>
       ${aggregateViolations(
-        pResults.summary.violations,
-        pResults.summary.ruleSetUsed,
-      )
-        .map(buildViolatedRuleRow)
-        .join("\n")}
+				pResults.summary.violations,
+				pResults.summary.ruleSetUsed,
+			)
+				.map(buildViolatedRuleRow)
+				.join("\n")}
       <tr>
         <td colspan="6" class="controls">
           <div id="show-unviolated">
@@ -74,7 +74,7 @@ function constructViolatedRulesTable(pResults) {
  * @returns {string}
  */
 function getViolationRowClass(pViolation) {
-  return pViolation.rule.severity === "ignore" ? ' class="ignored"' : "";
+	return pViolation.rule.severity === "ignore" ? ' class="ignored"' : "";
 }
 
 /**
@@ -82,8 +82,8 @@ function getViolationRowClass(pViolation) {
  * @returns {string}
  */
 function constructViolationRow(pPrefix) {
-  return (pViolation) => {
-    return `  <tr${getViolationRowClass(pViolation)}>
+	return (pViolation) => {
+		return `  <tr${getViolationRowClass(pViolation)}>
     <td class="${pViolation.rule.severity}">${pViolation.rule.severity}</td>
     <td class="nowrap">
       <a href="#${pViolation.rule.name}-definition" 
@@ -91,11 +91,11 @@ function constructViolationRow(pPrefix) {
          class="noiseless">${pViolation.rule.name}</a>
     </td>
     <td><a href="${pPrefix}${pViolation.from}">${
-      pViolation.from
-    }</a>${determineFromExtras(pViolation)}</td>
+			pViolation.from
+		}</a>${determineFromExtras(pViolation)}</td>
     <td>${determineTo(pViolation)}</td>
   </tr>`;
-  };
+	};
 }
 
 /**
@@ -103,8 +103,8 @@ function constructViolationRow(pPrefix) {
  * @returns {string}
  */
 function constructViolationsList(pResults) {
-  if (pResults.summary.violations.length > 0) {
-    return `<span id="show-ignored-violations">
+	if (pResults.summary.violations.length > 0) {
+		return `<span id="show-ignored-violations">
       <h2><svg class="p__svg--inline" viewBox="0 0 12 16" version="1.1" aria-hidden="true">
         <path fill-rule="evenodd"
           d="M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z">
@@ -121,11 +121,11 @@ function constructViolationsList(pResults) {
       </thead>
       <tbody>
       ${pResults.summary.violations
-        .map(constructViolationRow(pResults.summary.optionsUsed.prefix ?? ""))
-        .join("\n")}
+				.map(constructViolationRow(pResults.summary.optionsUsed.prefix ?? ""))
+				.join("\n")}
       ${
-        pResults.summary.ignore > 0
-          ? `<tr>
+				pResults.summary.ignore > 0
+					? `<tr>
         <td colspan="4" class="controls">
           <div id="show-ignored">
             &downarrow; <a href="#show-ignored-violations">also show ignored violations</a>
@@ -135,13 +135,13 @@ function constructViolationsList(pResults) {
           </div>
         </td>
       </tr>`
-          : ""
-      }
+					: ""
+			}
       </tbody>
     </table>
     </span>`;
-  }
-  return `    <h2><span aria-hidden="true">&hearts;</span> No violations found</h2>
+	}
+	return `    <h2><span aria-hidden="true">&hearts;</span> No violations found</h2>
     <p>Get gummy bears to celebrate.</p>`;
 }
 
@@ -150,20 +150,20 @@ function constructViolationsList(pResults) {
  * @returns {string}
  */
 function report(pResults) {
-  return template
-    .replace("{{totalCruised}}", pResults.summary.totalCruised)
-    .replace(
-      "{{totalDependenciesCruised}}",
-      pResults.summary.totalDependenciesCruised,
-    )
-    .replace("{{error}}", pResults.summary.error)
-    .replace("{{warn}}", pResults.summary.warn)
-    .replace("{{info}}", pResults.summary.info)
-    .replace("{{ignore}}", pResults.summary.ignore ?? 0)
-    .replace("{{violatedRulesTable}}", constructViolatedRulesTable(pResults))
-    .replace("{{violationsList}}", constructViolationsList(pResults))
-    .replace("{{depcruiseVersion}}", `dependency-cruiser@${meta.version}`)
-    .replace("{{runDate}}", new Date().toISOString());
+	return template
+		.replace("{{totalCruised}}", pResults.summary.totalCruised)
+		.replace(
+			"{{totalDependenciesCruised}}",
+			pResults.summary.totalDependenciesCruised,
+		)
+		.replace("{{error}}", pResults.summary.error)
+		.replace("{{warn}}", pResults.summary.warn)
+		.replace("{{info}}", pResults.summary.info)
+		.replace("{{ignore}}", pResults.summary.ignore ?? 0)
+		.replace("{{violatedRulesTable}}", constructViolatedRulesTable(pResults))
+		.replace("{{violationsList}}", constructViolationsList(pResults))
+		.replace("{{depcruiseVersion}}", `dependency-cruiser@${meta.version}`)
+		.replace("{{runDate}}", new Date().toISOString());
 }
 
 /**
@@ -174,8 +174,8 @@ function report(pResults) {
  *                              exitCode: 0
  */
 export default function errorHtml(pResults) {
-  return {
-    output: report(pResults),
-    exitCode: 0,
-  };
+	return {
+		output: report(pResults),
+		exitCode: 0,
+	};
 }

package/src/report/error-html/utl.mjs

@@ -2,139 +2,139 @@ import { formatViolation, formatPercentage } from "../utl/index.mjs";
 import meta from "#meta.cjs";
 
 export function getFormattedAllowedRule(pRuleSetUsed) {
-  const lAllowed = pRuleSetUsed?.allowed ?? [];
-  const lCommentedRule = lAllowed.find((pRule) =>
-    Object.hasOwn(pRule, "comment"),
-  );
-  const lComment = lCommentedRule ? lCommentedRule.comment : "-";
-
-  return lAllowed.length > 0
-    ? {
-        name: "not-in-allowed",
-        comment: lComment,
-        severity: pRuleSetUsed?.allowedSeverity ?? "warn",
-      }
-    : [];
+	const lAllowed = pRuleSetUsed?.allowed ?? [];
+	const lCommentedRule = lAllowed.find((pRule) =>
+		Object.hasOwn(pRule, "comment"),
+	);
+	const lComment = lCommentedRule ? lCommentedRule.comment : "-";
+
+	return lAllowed.length > 0
+		? {
+				name: "not-in-allowed",
+				comment: lComment,
+				severity: pRuleSetUsed?.allowedSeverity ?? "warn",
+			}
+		: [];
 }
 
 export function mergeCountsIntoRule(pRule, pViolationCounts) {
-  const lCounts = pViolationCounts[pRule.name]
-    ? pViolationCounts[pRule.name]
-    : { count: 0, ignoredCount: 0 };
-
-  return {
-    ...pRule,
-    count: lCounts.count,
-    ignoredCount: lCounts.ignoredCount,
-    unviolated: lCounts.count <= 0,
-  };
+	const lCounts = pViolationCounts[pRule.name]
+		? pViolationCounts[pRule.name]
+		: { count: 0, ignoredCount: 0 };
+
+	return {
+		...pRule,
+		count: lCounts.count,
+		ignoredCount: lCounts.ignoredCount,
+		unviolated: lCounts.count <= 0,
+	};
 }
 
 function formatCycleTo(pViolation) {
-  return pViolation.cycle.map(({ name }) => name).join(" &rightarrow;<br/>");
+	return pViolation.cycle.map(({ name }) => name).join(" &rightarrow;<br/>");
 }
 
 function formatReachabilityTo(pViolation) {
-  return `${pViolation.to}<br/>${pViolation.via
-    .map(({ name }) => name)
-    .join(" &rightarrow;<br/>")}`;
+	return `${pViolation.to}<br/>${pViolation.via
+		.map(({ name }) => name)
+		.join(" &rightarrow;<br/>")}`;
 }
 
 function formatDependencyTo(pViolation) {
-  return pViolation.to;
+	return pViolation.to;
 }
 
 function formatModuleTo() {
-  return "";
+	return "";
 }
 
 function formatInstabilityTo(pViolation) {
-  return `${pViolation.to}&nbsp;<span class="extra">(I: ${formatPercentage(
-    pViolation.metrics.to.instability,
-  )})</span>`;
+	return `${pViolation.to}&nbsp;<span class="extra">(I: ${formatPercentage(
+		pViolation.metrics.to.instability,
+	)})</span>`;
 }
 
 export function determineTo(pViolation) {
-  const lViolationType2Formatter = {
-    dependency: formatDependencyTo,
-    module: formatModuleTo,
-    cycle: formatCycleTo,
-    reachability: formatReachabilityTo,
-    instability: formatInstabilityTo,
-  };
-  return formatViolation(
-    pViolation,
-    lViolationType2Formatter,
-    formatDependencyTo,
-  );
+	const lViolationType2Formatter = {
+		dependency: formatDependencyTo,
+		module: formatModuleTo,
+		cycle: formatCycleTo,
+		reachability: formatReachabilityTo,
+		instability: formatInstabilityTo,
+	};
+	return formatViolation(
+		pViolation,
+		lViolationType2Formatter,
+		formatDependencyTo,
+	);
 }
 
 function formatInstabilityFromExtras(pViolation) {
-  return `&nbsp;<span class="extra">(I: ${formatPercentage(
-    pViolation.metrics.from.instability,
-  )})</span>`;
+	return `&nbsp;<span class="extra">(I: ${formatPercentage(
+		pViolation.metrics.from.instability,
+	)})</span>`;
 }
 
 export function determineFromExtras(pViolation) {
-  const lViolationType2Formatter = {
-    instability: formatInstabilityFromExtras,
-  };
-  return formatViolation(pViolation, lViolationType2Formatter, () => "");
+	const lViolationType2Formatter = {
+		instability: formatInstabilityFromExtras,
+	};
+	return formatViolation(pViolation, lViolationType2Formatter, () => "");
 }
 
 export function formatSummaryForReport(pSummary) {
-  return {
-    ...pSummary,
-    depcruiseVersion: `dependency-cruiser@${meta.version}`,
-    runDate: new Date().toISOString(),
-    violations: (pSummary.violations || []).map((pViolation) => ({
-      ...pViolation,
-      fromExtras: determineFromExtras(pViolation),
-      to: determineTo(pViolation),
-    })),
-  };
+	return {
+		...pSummary,
+		depcruiseVersion: `dependency-cruiser@${meta.version}`,
+		runDate: new Date().toISOString(),
+		violations: (pSummary.violations || []).map((pViolation) => ({
+			...pViolation,
+			fromExtras: determineFromExtras(pViolation),
+			to: determineTo(pViolation),
+		})),
+	};
 }
 
 function aggregateCountsPerRule(pViolations) {
-  return pViolations.reduce((pAll, pCurrentViolation) => {
-    if (pAll[pCurrentViolation.rule.name]) {
-      pAll[pCurrentViolation.rule.name] =
-        pCurrentViolation.rule.severity === "ignore"
-          ? {
-              count: pAll[pCurrentViolation.rule.name].count,
-              ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount + 1,
-            }
-          : {
-              count: pAll[pCurrentViolation.rule.name].count + 1,
-              ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount,
-            };
-    } else {
-      pAll[pCurrentViolation.rule.name] =
-        pCurrentViolation.rule.severity === "ignore"
-          ? {
-              count: 0,
-              ignoredCount: 1,
-            }
-          : {
-              count: 1,
-              ignoredCount: 0,
-            };
-    }
-    return pAll;
-  }, {});
+	return pViolations.reduce((pAll, pCurrentViolation) => {
+		if (pAll[pCurrentViolation.rule.name]) {
+			pAll[pCurrentViolation.rule.name] =
+				pCurrentViolation.rule.severity === "ignore"
+					? {
+							count: pAll[pCurrentViolation.rule.name].count,
+							ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount + 1,
+						}
+					: {
+							count: pAll[pCurrentViolation.rule.name].count + 1,
+							ignoredCount: pAll[pCurrentViolation.rule.name].ignoredCount,
+						};
+		} else {
+			pAll[pCurrentViolation.rule.name] =
+				pCurrentViolation.rule.severity === "ignore"
+					? {
+							count: 0,
+							ignoredCount: 1,
+						}
+					: {
+							count: 1,
+							ignoredCount: 0,
+						};
+		}
+		return pAll;
+	}, {});
 }
 
 export function aggregateViolations(pViolations, pRuleSetUsed) {
-  const lViolationCounts = aggregateCountsPerRule(pViolations);
-
-  return (pRuleSetUsed?.forbidden ?? [])
-    .concat(pRuleSetUsed?.required ?? [])
-    .concat(getFormattedAllowedRule(pRuleSetUsed))
-    .map((pRule) => mergeCountsIntoRule(pRule, lViolationCounts))
-    .sort(
-      (pFirst, pSecond) =>
-        Math.sign(pSecond.count - pFirst.count) ||
-        Math.sign(pSecond.ignoredCount - pFirst.ignoredCount) ||
-        pFirst.name.localeCompare(pSecond.name),
-    );
+	const lViolationCounts = aggregateCountsPerRule(pViolations);
+
+	return (pRuleSetUsed?.forbidden ?? [])
+		.concat(pRuleSetUsed?.required ?? [])
+		.concat(getFormattedAllowedRule(pRuleSetUsed))
+		.map((pRule) => mergeCountsIntoRule(pRule, lViolationCounts))
+		.sort(
+			(pFirst, pSecond) =>
+				Math.sign(pSecond.count - pFirst.count) ||
+				Math.sign(pSecond.ignoredCount - pFirst.ignoredCount) ||
+				pFirst.name.localeCompare(pSecond.name),
+		);
 }

package/src/report/error-long.mjs

@@ -1,5 +1,5 @@
 import error from "./error.mjs";
 
 export default function errorLong(pResults, pOptions) {
-  return error(pResults, { ...pOptions, long: true });
+	return error(pResults, { ...pOptions, long: true });
 }