dependency-cruiser 17.3.2 → 17.3.3-beta-2

package/src/report/dot/default-theme.mjs

@@ -1,154 +1,154 @@
 export default {
-  graph: {
-    rankdir: "LR",
-    splines: "true",
-    overlap: "false",
-    nodesep: "0.16",
-    ranksep: "0.18",
-    fontname: "Helvetica-bold",
-    fontsize: "9",
-    style: "rounded,bold,filled",
-    fillcolor: "#ffffff",
-    compound: "true",
-  },
-  node: {
-    shape: "box",
-    style: "rounded, filled",
-    height: "0.2",
-    color: "black",
-    fillcolor: "#ffffcc",
-    fontcolor: "black",
-    fontname: "Helvetica",
-    fontsize: 9,
-  },
-  edge: {
-    arrowhead: "normal",
-    arrowsize: "0.6",
-    penwidth: "2.0",
-    color: "#00000033",
-    fontname: "Helvetica",
-    fontsize: "9",
-  },
-  modules: [
-    {
-      criteria: { consolidated: true },
-      attributes: { shape: "box3d" },
-    },
-    {
-      criteria: { "rules[0].severity": "error" },
-      attributes: { fontcolor: "red", color: "red" },
-    },
-    {
-      criteria: { "rules[0].severity": "warn" },
-      attributes: { fontcolor: "orange", color: "orange" },
-    },
-    {
-      criteria: { "rules[0].severity": "info" },
-      attributes: { fontcolor: "blue", color: "blue" },
-    },
-    {
-      criteria: { coreModule: true },
-      attributes: { color: "grey", fontcolor: "grey" },
-    },
-    {
-      criteria: { source: "node_modules" },
-      attributes: { fillcolor: "#c40b0a1a", fontcolor: "#c40b0a" },
-    },
-    {
-      criteria: { matchesDoNotFollow: true },
-      attributes: { shape: "folder" },
-    },
-    {
-      criteria: { orphan: true },
-      attributes: { fillcolor: "#ccffcc" },
-    },
-    {
-      criteria: { source: "\\.json$" },
-      attributes: { fillcolor: "#ffee44" },
-    },
-    {
-      criteria: { source: "\\.jsx$" },
-      attributes: { fillcolor: "#ffff77" },
-    },
-    {
-      criteria: { source: "\\.vue$" },
-      attributes: { fillcolor: "#41f083" },
-    },
-    {
-      criteria: { source: "\\.([cm]?ts)$" },
-      attributes: { fillcolor: "#ddfeff" },
-    },
-    {
-      criteria: { source: "\\.tsx$" },
-      attributes: { fillcolor: "#bbfeff" },
-    },
-    {
-      criteria: { source: "\\.svelte$" },
-      attributes: { fillcolor: "#febbff" },
-    },
-    {
-      criteria: { source: "(\\.coffee|\\.litcoffee|\\.coffee\\.md)$" },
-      attributes: { fillcolor: "#eeccaa" },
-    },
-    {
-      criteria: { source: "(\\.csx|\\.cjsx)$" },
-      attributes: { fillcolor: "#eebb77" },
-    },
-    {
-      criteria: { source: "\\.ls$/g" },
-      attributes: { fillcolor: "pink" },
-    },
-    {
-      criteria: { matchesHighlight: true },
-      attributes: {
-        fillcolor: "lime",
-        penwidth: 2,
-      },
-    },
-  ],
-  dependencies: [
-    {
-      criteria: { "rules[0].severity": "error" },
-      attributes: { fontcolor: "red", color: "red" },
-    },
-    {
-      criteria: { "rules[0].severity": "warn" },
-      attributes: { fontcolor: "orange", color: "orange" },
-    },
-    {
-      criteria: { "rules[0].severity": "info" },
-      attributes: { fontcolor: "blue", color: "blue" },
-    },
-    {
-      criteria: { dynamic: true },
-      attributes: { style: "dashed" },
-    },
-    {
-      criteria: { circular: true },
-      attributes: { arrowhead: "normalnoneodot" },
-    },
-    {
-      criteria: {
-        dependencyTypes: [
-          "pre-compilation-only",
-          "triple-slash-type-reference",
-          "type-import",
-          "type-only",
-        ],
-      },
-      attributes: { arrowhead: "onormal", penwidth: "1.0" },
-    },
-    {
-      criteria: { dependencyTypes: ["export"] },
-      attributes: { arrowhead: "inv" },
-    },
-    {
-      criteria: { dependencyTypes: "core" },
-      attributes: { style: "dashed", penwidth: "1.0" },
-    },
-    {
-      criteria: { dependencyTypes: "npm" },
-      attributes: { penwidth: "1.0" },
-    },
-  ],
+	graph: {
+		rankdir: "LR",
+		splines: "true",
+		overlap: "false",
+		nodesep: "0.16",
+		ranksep: "0.18",
+		fontname: "Helvetica-bold",
+		fontsize: "9",
+		style: "rounded,bold,filled",
+		fillcolor: "#ffffff",
+		compound: "true",
+	},
+	node: {
+		shape: "box",
+		style: "rounded, filled",
+		height: "0.2",
+		color: "black",
+		fillcolor: "#ffffcc",
+		fontcolor: "black",
+		fontname: "Helvetica",
+		fontsize: 9,
+	},
+	edge: {
+		arrowhead: "normal",
+		arrowsize: "0.6",
+		penwidth: "2.0",
+		color: "#00000033",
+		fontname: "Helvetica",
+		fontsize: "9",
+	},
+	modules: [
+		{
+			criteria: { consolidated: true },
+			attributes: { shape: "box3d" },
+		},
+		{
+			criteria: { "rules[0].severity": "error" },
+			attributes: { fontcolor: "red", color: "red" },
+		},
+		{
+			criteria: { "rules[0].severity": "warn" },
+			attributes: { fontcolor: "orange", color: "orange" },
+		},
+		{
+			criteria: { "rules[0].severity": "info" },
+			attributes: { fontcolor: "blue", color: "blue" },
+		},
+		{
+			criteria: { coreModule: true },
+			attributes: { color: "grey", fontcolor: "grey" },
+		},
+		{
+			criteria: { source: "node_modules" },
+			attributes: { fillcolor: "#c40b0a1a", fontcolor: "#c40b0a" },
+		},
+		{
+			criteria: { matchesDoNotFollow: true },
+			attributes: { shape: "folder" },
+		},
+		{
+			criteria: { orphan: true },
+			attributes: { fillcolor: "#ccffcc" },
+		},
+		{
+			criteria: { source: "\\.json$" },
+			attributes: { fillcolor: "#ffee44" },
+		},
+		{
+			criteria: { source: "\\.jsx$" },
+			attributes: { fillcolor: "#ffff77" },
+		},
+		{
+			criteria: { source: "\\.vue$" },
+			attributes: { fillcolor: "#41f083" },
+		},
+		{
+			criteria: { source: "\\.([cm]?ts)$" },
+			attributes: { fillcolor: "#ddfeff" },
+		},
+		{
+			criteria: { source: "\\.tsx$" },
+			attributes: { fillcolor: "#bbfeff" },
+		},
+		{
+			criteria: { source: "\\.svelte$" },
+			attributes: { fillcolor: "#febbff" },
+		},
+		{
+			criteria: { source: "(\\.coffee|\\.litcoffee|\\.coffee\\.md)$" },
+			attributes: { fillcolor: "#eeccaa" },
+		},
+		{
+			criteria: { source: "(\\.csx|\\.cjsx)$" },
+			attributes: { fillcolor: "#eebb77" },
+		},
+		{
+			criteria: { source: "\\.ls$/g" },
+			attributes: { fillcolor: "pink" },
+		},
+		{
+			criteria: { matchesHighlight: true },
+			attributes: {
+				fillcolor: "lime",
+				penwidth: 2,
+			},
+		},
+	],
+	dependencies: [
+		{
+			criteria: { "rules[0].severity": "error" },
+			attributes: { fontcolor: "red", color: "red" },
+		},
+		{
+			criteria: { "rules[0].severity": "warn" },
+			attributes: { fontcolor: "orange", color: "orange" },
+		},
+		{
+			criteria: { "rules[0].severity": "info" },
+			attributes: { fontcolor: "blue", color: "blue" },
+		},
+		{
+			criteria: { dynamic: true },
+			attributes: { style: "dashed" },
+		},
+		{
+			criteria: { circular: true },
+			attributes: { arrowhead: "normalnoneodot" },
+		},
+		{
+			criteria: {
+				dependencyTypes: [
+					"pre-compilation-only",
+					"triple-slash-type-reference",
+					"type-import",
+					"type-only",
+				],
+			},
+			attributes: { arrowhead: "onormal", penwidth: "1.0" },
+		},
+		{
+			criteria: { dependencyTypes: ["export"] },
+			attributes: { arrowhead: "inv" },
+		},
+		{
+			criteria: { dependencyTypes: "core" },
+			attributes: { style: "dashed", penwidth: "1.0" },
+		},
+		{
+			criteria: { dependencyTypes: "npm" },
+			attributes: { penwidth: "1.0" },
+		},
+	],
 };

package/src/report/dot/index.mjs

@@ -11,201 +11,201 @@ import { get } from "#utl/object-util.mjs";
 const EOL = "\n";
 
 const GRANULARITY2FUNCTION = new Map([
-  ["module", prepareCustomLevel],
-  ["folder", prepareFolderLevel],
-  ["custom", prepareCustomLevel],
-  ["flat", prepareFlatLevel],
+	["module", prepareCustomLevel],
+	["folder", prepareFolderLevel],
+	["custom", prepareCustomLevel],
+	["flat", prepareFlatLevel],
 ]);
 
 const GRANULARITY2REPORTER_OPTIONS = new Map([
-  ["module", "summary.optionsUsed.reporterOptions.dot"],
-  ["folder", "summary.optionsUsed.reporterOptions.ddot"],
-  ["custom", "summary.optionsUsed.reporterOptions.archi"],
-  ["flat", "summary.optionsUsed.reporterOptions.flat"],
+	["module", "summary.optionsUsed.reporterOptions.dot"],
+	["folder", "summary.optionsUsed.reporterOptions.ddot"],
+	["custom", "summary.optionsUsed.reporterOptions.archi"],
+	["flat", "summary.optionsUsed.reporterOptions.flat"],
 ]);
 
 function buildGraphAttributes(pGraph) {
-  return pGraph ? `    ${attributizeObject(pGraph)}` : "";
+	return pGraph ? `    ${attributizeObject(pGraph)}` : "";
 }
 
 function buildNodeAttributes(pNode) {
-  return pNode ? `    node [${attributizeObject(pNode)}]` : "";
+	return pNode ? `    node [${attributizeObject(pNode)}]` : "";
 }
 
 function buildEdgeAttributes(pEdge) {
-  return pEdge ? `    edge [${attributizeObject(pEdge)}]` : "";
+	return pEdge ? `    edge [${attributizeObject(pEdge)}]` : "";
 }
 
 function buildGeneralAttributes(pTheme) {
-  return (
-    buildGraphAttributes(pTheme.graph) +
-    EOL +
-    buildNodeAttributes(pTheme.node) +
-    EOL +
-    buildEdgeAttributes(pTheme.edge) +
-    EOL
-  );
+	return (
+		buildGraphAttributes(pTheme.graph) +
+		EOL +
+		buildNodeAttributes(pTheme.node) +
+		EOL +
+		buildEdgeAttributes(pTheme.edge) +
+		EOL
+	);
 }
 
 function buildSingleFlatModule(pModule) {
-  return `"${pModule.source}" [label=${pModule.label} tooltip="${
-    pModule.tooltip
-  }" ${pModule.URL ? 'URL="' + pModule.URL + '" ' : ""}${
-    pModule.themeAttrs ?? ""
-  }]`;
+	return `"${pModule.source}" [label=${pModule.label} tooltip="${
+		pModule.tooltip
+	}" ${pModule.URL ? 'URL="' + pModule.URL + '" ' : ""}${
+		pModule.themeAttrs ?? ""
+	}]`;
 }
 
 function buildSinglePath(pClustersHaveOwnNode) {
-  return (pPath) => {
-    let lReturnValue = `subgraph "cluster_${pPath.aggregateSnippet}" {label="${pPath.snippet}"`;
-    if (pClustersHaveOwnNode) {
-      lReturnValue += ` "${pPath.aggregateSnippet}" [width="0.05" shape="point" style="invis"]`;
-    }
-    return lReturnValue;
-  };
+	return (pPath) => {
+		let lReturnValue = `subgraph "cluster_${pPath.aggregateSnippet}" {label="${pPath.snippet}"`;
+		if (pClustersHaveOwnNode) {
+			lReturnValue += ` "${pPath.aggregateSnippet}" [width="0.05" shape="point" style="invis"]`;
+		}
+		return lReturnValue;
+	};
 }
 
 function buildModuleHierarchy(pModule, pClustersHaveOwnNode) {
-  return (
-    pModule.path.map(buildSinglePath(pClustersHaveOwnNode)).join(" ") +
-    " " +
-    buildSingleFlatModule(pModule) +
-    " }".repeat(pModule.path.length)
-  );
+	return (
+		pModule.path.map(buildSinglePath(pClustersHaveOwnNode)).join(" ") +
+		" " +
+		buildSingleFlatModule(pModule) +
+		" }".repeat(pModule.path.length)
+	);
 }
 
 function buildDependency(pModuleSource) {
-  return (pDependency) => {
-    let lReturnValue = `    "${pModuleSource}" -> "${pDependency.resolved}"`;
-    if (pDependency.hasExtraAttributes) {
-      lReturnValue +=
-        " [" +
-        (pDependency?.rule?.name
-          ? `xlabel="${pDependency.rule.name}" tooltip="${pDependency.rule.name}" `
-          : "") +
-        (pDependency?.themeAttrs ?? "") +
-        "]";
-    }
-    return lReturnValue;
-  };
+	return (pDependency) => {
+		let lReturnValue = `    "${pModuleSource}" -> "${pDependency.resolved}"`;
+		if (pDependency.hasExtraAttributes) {
+			lReturnValue +=
+				" [" +
+				(pDependency?.rule?.name
+					? `xlabel="${pDependency.rule.name}" tooltip="${pDependency.rule.name}" `
+					: "") +
+				(pDependency?.themeAttrs ?? "") +
+				"]";
+		}
+		return lReturnValue;
+	};
 }
 
 function buildModule(pClustersHaveOwnNode) {
-  return (pModule) => {
-    let lReturnValue = pModule.folder
-      ? `    ${buildModuleHierarchy(pModule, pClustersHaveOwnNode)}`
-      : `    ${buildSingleFlatModule(pModule)}`;
-    if (pModule.dependencies && pModule.dependencies.length > 0) {
-      lReturnValue +=
-        EOL +
-        pModule.dependencies.map(buildDependency(pModule.source)).join(EOL);
-    }
+	return (pModule) => {
+		let lReturnValue = pModule.folder
+			? `    ${buildModuleHierarchy(pModule, pClustersHaveOwnNode)}`
+			: `    ${buildSingleFlatModule(pModule)}`;
+		if (pModule.dependencies && pModule.dependencies.length > 0) {
+			lReturnValue +=
+				EOL +
+				pModule.dependencies.map(buildDependency(pModule.source)).join(EOL);
+		}
 
-    return lReturnValue;
-  };
+		return lReturnValue;
+	};
 }
 
 function buildModules(pModules, pClustersHaveOwnNode) {
-  return pModules.map(buildModule(pClustersHaveOwnNode)).join(EOL);
+	return pModules.map(buildModule(pClustersHaveOwnNode)).join(EOL);
 }
 
 function report(
-  pResults,
-  pGranularity,
-  { theme, collapsePattern, filters, showMetrics },
+	pResults,
+	pGranularity,
+	{ theme, collapsePattern, filters, showMetrics },
 ) {
-  const lTheme = normalizeTheme(theme);
-  const lResults = filters
-    ? {
-        ...pResults,
-        modules: applyFilters(pResults.modules, filters),
-      }
-    : pResults;
-
-  return (
-    'strict digraph "dependency-cruiser output"{' +
-    EOL +
-    buildGeneralAttributes(lTheme) +
-    EOL +
-    buildModules(
-      (GRANULARITY2FUNCTION.get(pGranularity) || prepareCustomLevel)(
-        lResults,
-        lTheme,
-        collapsePattern,
-        showMetrics,
-      ),
-      pGranularity === "folder",
-    ) +
-    EOL +
-    `}${EOL}`
-  );
+	const lTheme = normalizeTheme(theme);
+	const lResults = filters
+		? {
+				...pResults,
+				modules: applyFilters(pResults.modules, filters),
+			}
+		: pResults;
+
+	return (
+		'strict digraph "dependency-cruiser output"{' +
+		EOL +
+		buildGeneralAttributes(lTheme) +
+		EOL +
+		buildModules(
+			(GRANULARITY2FUNCTION.get(pGranularity) || prepareCustomLevel)(
+				lResults,
+				lTheme,
+				collapsePattern,
+				showMetrics,
+			),
+			pGranularity === "folder",
+		) +
+		EOL +
+		`}${EOL}`
+	);
 }
 
 function pryReporterOptionsFromResults(pGranularity, pResults) {
-  const lFallbackReporterOptions =
-    pResults?.summary?.optionsUsed?.reporterOptions?.dot;
+	const lFallbackReporterOptions =
+		pResults?.summary?.optionsUsed?.reporterOptions?.dot;
 
-  // using a bespoke 'get' function here because the reporter options will
-  // contain nested properties, which it handles for us
-  return get(
-    pResults,
-    GRANULARITY2REPORTER_OPTIONS.get(pGranularity),
-    lFallbackReporterOptions,
-  );
+	// using a bespoke 'get' function here because the reporter options will
+	// contain nested properties, which it handles for us
+	return get(
+		pResults,
+		GRANULARITY2REPORTER_OPTIONS.get(pGranularity),
+		lFallbackReporterOptions,
+	);
 }
 
 function pryThemeFromResults(pGranularity, pResults) {
-  const lFallbackTheme =
-    pResults?.summary?.optionsUsed?.reporterOptions?.dot?.theme;
+	const lFallbackTheme =
+		pResults?.summary?.optionsUsed?.reporterOptions?.dot?.theme;
 
-  return (
-    pryReporterOptionsFromResults(pGranularity, pResults)?.theme ??
-    lFallbackTheme
-  );
+	return (
+		pryReporterOptionsFromResults(pGranularity, pResults)?.theme ??
+		lFallbackTheme
+	);
 }
 
 function pryFiltersFromResults(pGranularity, pResults) {
-  const lFallbackFilters =
-    pResults?.summary?.optionsUsed?.reporterOptions?.dot?.filters;
+	const lFallbackFilters =
+		pResults?.summary?.optionsUsed?.reporterOptions?.dot?.filters;
 
-  return (
-    pryReporterOptionsFromResults(pGranularity, pResults)?.filters ??
-    lFallbackFilters
-  );
+	return (
+		pryReporterOptionsFromResults(pGranularity, pResults)?.filters ??
+		lFallbackFilters
+	);
 }
 
 function getCollapseFallbackPattern(pGranularity) {
-  if (pGranularity === "custom") {
-    return "^(node_modules|packages|src|lib|app|test|spec)/[^/]+";
-  }
-  return null;
+	if (pGranularity === "custom") {
+		return "^(node_modules|packages|src|lib|app|test|spec)/[^/]+";
+	}
+	return null;
 }
 
 function pryCollapsePatternFromResults(pGranularity, pResults) {
-  return (
-    pryReporterOptionsFromResults(pGranularity, pResults)?.collapsePattern ??
-    getCollapseFallbackPattern(pGranularity)
-  );
+	return (
+		pryReporterOptionsFromResults(pGranularity, pResults)?.collapsePattern ??
+		getCollapseFallbackPattern(pGranularity)
+	);
 }
 
 function normalizeDotReporterOptions(
-  pDotReporterOptions,
-  pGranularity,
-  pResults,
+	pDotReporterOptions,
+	pGranularity,
+	pResults,
 ) {
-  let lDotReporterOptions = pDotReporterOptions || {};
+	let lDotReporterOptions = pDotReporterOptions || {};
 
-  return {
-    theme:
-      lDotReporterOptions.theme || pryThemeFromResults(pGranularity, pResults),
-    collapsePattern:
-      lDotReporterOptions.collapsePattern ||
-      pryCollapsePatternFromResults(pGranularity, pResults),
-    filters:
-      lDotReporterOptions.filters ||
-      pryFiltersFromResults(pGranularity, pResults),
-    ...lDotReporterOptions,
-  };
+	return {
+		theme:
+			lDotReporterOptions.theme || pryThemeFromResults(pGranularity, pResults),
+		collapsePattern:
+			lDotReporterOptions.collapsePattern ||
+			pryCollapsePatternFromResults(pGranularity, pResults),
+		filters:
+			lDotReporterOptions.filters ||
+			pryFiltersFromResults(pGranularity, pResults),
+		...lDotReporterOptions,
+	};
 }
 
 /**
@@ -217,16 +217,16 @@ function normalizeDotReporterOptions(
  * @returns {(pResults, pDotReporterOptions) => import("../../../types/dependency-cruiser.js").IReporterOutput}
  */
 export default function produceDotReporter(pGranularity) {
-  return function dot(pResults, pDotReporterOptions) {
-    const lDotReporterOptions = normalizeDotReporterOptions(
-      pDotReporterOptions,
-      pGranularity,
-      pResults,
-    );
-
-    return {
-      output: report(pResults, pGranularity, lDotReporterOptions),
-      exitCode: 0,
-    };
-  };
+	return function dot(pResults, pDotReporterOptions) {
+		const lDotReporterOptions = normalizeDotReporterOptions(
+			pDotReporterOptions,
+			pGranularity,
+			pResults,
+		);
+
+		return {
+			output: report(pResults, pGranularity, lDotReporterOptions),
+			exitCode: 0,
+		};
+	};
 }