dependency-cruiser 13.1.0-beta-1 → 13.1.0-beta-2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "13.1.0-beta-1",
+  "version": "13.1.0-beta-2",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "13.1.0-beta-1",
+  version: "13.1.0-beta-2",
   engines: {
     node: "^16.14||>=18",
   },

package/src/report/azure-devops.mjs

@@ -1,25 +1,8 @@
-/*
-Message grouping
-##[group]Beginning of a group
-##[warning]Warning message
-##[error]Error message
-##[section]Start of a section
-##[debug]Debug text
-##[command]Command-line being run
-##[endgroup]
-
-Warnings and errors:
-
-##vso[task.logissue type=warning;sourcepath=consoleapp/main.cs;linenumber=1;columnnumber=1;code=100;]Found something that could be a problem.
-
-Progress
-##vso[task.setprogress]current operation
-
-Complete
-##vso[task.complete]current operation
-*/
-
 import { EOL } from "node:os";
+import {
+  formatPercentage,
+  formatViolation as _formatViolation,
+} from "./utl/index.mjs";
 
 const SEVERITY2VSO_TYPE = new Map([
   // "error" | "warn" | "info" | "ignore
@@ -31,30 +14,149 @@ const SEVERITY2VSO_TYPE = new Map([
 ]);
 
 /**
- *
  * @param {import("../../types/shared-types.js").SeverityType} pSeverity
+ * @returns {string}
  */
 function formatSeverity(pSeverity) {
   return SEVERITY2VSO_TYPE.get(pSeverity) ?? "warning";
 }
 
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
+function formatModuleViolation(pViolation) {
+  return `${pViolation.rule.name}: ${pViolation.from}`;
+}
+
 /**
  *
  * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
+function formatDependencyViolation(pViolation) {
+  return `${pViolation.rule.name}: ${pViolation.from} -> ${pViolation.to}`;
+}
+
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
+function formatCycleViolation(pViolation) {
+  return `${pViolation.rule.name}: ${
+    pViolation.from
+  } -> ${pViolation.cycle.join(" -> ")}`;
+}
+
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
+function formatReachabilityViolation(pViolation) {
+  return `${pViolation.rule.name}: ${pViolation.from} -> ${
+    pViolation.to
+  } (via ${pViolation.via.join(" -> ")})`;
+}
+
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
+ */
+function formatInstabilityViolation(pViolation) {
+  return `${pViolation.rule.name}: ${pViolation.from} -> ${
+    pViolation.to
+  } (instability: ${formatPercentage(
+    pViolation.metrics.from.instability
+  )} -> ${formatPercentage(pViolation.metrics.to.instability)})`;
+}
+
+/**
+ * @param {import("../../types/violations.js").IViolation} pViolation
+ * @returns {string}
  */
 function formatViolation(pViolation) {
+  const lViolationType2Formatter = {
+    module: formatModuleViolation,
+    dependency: formatDependencyViolation,
+    cycle: formatCycleViolation,
+    reachability: formatReachabilityViolation,
+    instability: formatInstabilityViolation,
+  };
+  let lFormattedViolators = _formatViolation(
+    pViolation,
+    lViolationType2Formatter,
+    formatDependencyViolation
+  );
   return `##vso[task.logissue type=${formatSeverity(
     pViolation.rule.severity
-  )};sourcepath=${pViolation.from}]${pViolation.rule.name}`;
+  )};sourcepath=${pViolation.from}]${lFormattedViolators}${EOL}`;
 }
 
 /**
  *
  * @param {number} pNumberOfErrors
+ * @param {number} pNumberOfWarns
+ * @param {number} pNumberOfInfos
+ *
  * @returns
  */
-function formatSuccess(pNumberOfErrors) {
-  return pNumberOfErrors === 0 ? "Succeeded" : "Failed";
+function formatResultStatus(
+  pNumberOfErrors,
+  pNumberOfWarns,
+  pNumberOfInfos,
+  pNumberOfIgnored
+) {
+  if (pNumberOfErrors > 0) {
+    return "Failed";
+  }
+  if (pNumberOfWarns + pNumberOfInfos + pNumberOfIgnored > 0) {
+    return "SucceededWithIssues";
+  }
+  return "Succeeded";
+}
+
+function formatMeta(pMeta) {
+  const lWarningCount = pMeta.warn + pMeta.info;
+  const lError = `${pMeta.error} error`;
+  const lWarn = `${lWarningCount} warning/ informational`;
+  const lIgnore = (pMeta?.ignore ?? 0) > 0 ? `, ${pMeta.ignore} ignored` : "";
+
+  return `${lError}, ${lWarn}${lIgnore}`;
+}
+
+function sumMeta(pMeta) {
+  return pMeta.error + pMeta.warn + pMeta.info;
+}
+
+/**
+ *
+ * @param {number} pNumberOfIgnored
+ * @returns {string}
+ */
+function formatIgnoreWarning(pNumberOfIgnored) {
+  return (pNumberOfIgnored ?? 0) > 0
+    ? ` - ${pNumberOfIgnored} violations ignored `
+    : "";
+}
+
+/**
+ *
+ * @param {import("../../types/cruise-result.js").ISummary} pSummary
+ */
+function formatResultMessage(pSummary) {
+  let lStatSummary = `${pSummary.totalCruised} modules, ${
+    pSummary?.totalDependenciesCruised ?? 0
+  } dependencies cruised`;
+
+  if (sumMeta(pSummary) > 0) {
+    return `${sumMeta(pSummary)} dependency violations (${formatMeta(
+      pSummary
+    )}). ${lStatSummary}`;
+  } else {
+    return `no dependency violations found${formatIgnoreWarning(
+      pSummary.ignore
+    )} (${lStatSummary})`;
+  }
 }
 
 /**
@@ -62,16 +164,20 @@ function formatSuccess(pNumberOfErrors) {
  * @param {import("../../types/cruise-result.js").ISummary} pSummary
  */
 function formatSummary(pSummary) {
-  return `##vso[task.complete result=${formatSuccess(pSummary.error)};] ${
-    pSummary.totalCruised
-  } modules, ${pSummary.totalDependenciesCruised} dependencies cruised`;
+  return `##vso[task.complete result=${formatResultStatus(
+    pSummary.error,
+    pSummary.warn,
+    pSummary.info,
+    pSummary?.ignore ?? 0
+  )};]${formatResultMessage(pSummary)}${EOL}`;
 }
 
 /**
  * Returns a bunch of Azure DevOps log messages:
- * - for each violated rule in the passed results: gnork
- * - for each violation in the passed results: bork
+ * - for each violation in the passed results: the severity, source found, violated rule & some additional info
+ * - a summary line
  *
+ * Background documentation:
  * https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#task-commands
  *
  * @param {import("../../types/dependency-cruiser.js").ICruiseResult} pResults
@@ -79,25 +185,38 @@ function formatSummary(pSummary) {
  */
 // eslint-disable-next-line unicorn/prevent-abbreviations
 export default function azureDevOps(pResults) {
-  // this is the documented way to get tsm to emit strings
-  // Alternatively we could've used the 'low level API', which
-  // involves creating new `Message`s and stringifying those.
-  // The abstraction of the 'higher level API' makes this
-  // reporter more easy to implement and maintain, despite
-  // setting this property directly
-
   const lViolations = (pResults?.summary?.violations ?? []).filter(
     (pViolation) => pViolation.rule.severity !== "ignore"
   );
-  const lIgnoredCount = pResults?.summary?.ignore ?? 0;
 
   return {
     output: lViolations
       .map(formatViolation)
-      .join(EOL)
-      .concat(EOL)
-      .concat(formatSummary(pResults.summary))
-      .concat(EOL),
+      .join("")
+      .concat(formatSummary(pResults.summary)),
     exitCode: pResults.summary.error,
   };
 }
+
+/*
+Some notes from the documentation over at https://learn.microsoft.com/en-us/azure/devops/pipelines/scripts/logging-commands?view=azure-devops&tabs=bash#task-commands
+
+Warnings and errors:
+
+##vso[task.logissue type=warning;sourcepath=consoleapp/main.cs;linenumber=1;columnnumber=1;code=100;]Found something that could be a problem.
+
+Progress
+##vso[task.setprogress]current operation
+
+Complete
+##vso[task.complete]current operation
+
+Message grouping
+##[group]Beginning of a group
+##[warning]Warning message
+##[error]Error message
+##[section]Start of a section
+##[debug]Debug text
+##[command]Command-line being run
+##[endgroup]
+*/

package/src/report/index.mjs

@@ -1,28 +1,28 @@
 import { getExternalPluginReporter } from "./plugins.mjs";
 
-const TYPE2MODULE = {
-  anon: "./anon/index.mjs",
-  csv: "./csv.mjs",
-  dot: "./dot/dot-module.mjs",
-  ddot: "./dot/dot-folder.mjs",
-  cdot: "./dot/dot-custom.mjs",
-  archi: "./dot/dot-custom.mjs",
-  fdot: "./dot/dot-flat.mjs",
-  flat: "./dot/dot-flat.mjs",
-  "err-html": "./error-html/index.mjs",
-  markdown: "./markdown.mjs",
-  "err-long": "./error-long.mjs",
-  err: "./error.mjs",
-  html: "./html/index.mjs",
-  json: "./json.mjs",
-  teamcity: "./teamcity.mjs",
-  text: "./text.mjs",
-  baseline: "./baseline.mjs",
-  metrics: "./metrics.mjs",
-  mermaid: "./mermaid.mjs",
-  null: "./null.mjs",
-  "azure-devops": "./azure-devops.mjs",
-};
+const TYPE2MODULE = new Map([
+  ["anon", "./anon/index.mjs"],
+  ["csv", "./csv.mjs"],
+  ["dot", "./dot/dot-module.mjs"],
+  ["ddot", "./dot/dot-folder.mjs"],
+  ["cdot", "./dot/dot-custom.mjs"],
+  ["archi", "./dot/dot-custom.mjs"],
+  ["fdot", "./dot/dot-flat.mjs"],
+  ["flat", "./dot/dot-flat.mjs"],
+  ["err-html", "./error-html/index.mjs"],
+  ["markdown", "./markdown.mjs"],
+  ["err-long", "./error-long.mjs"],
+  ["err", "./error.mjs"],
+  ["html", "./html/index.mjs"],
+  ["json", "./json.mjs"],
+  ["teamcity", "./teamcity.mjs"],
+  ["text", "./text.mjs"],
+  ["baseline", "./baseline.mjs"],
+  ["metrics", "./metrics.mjs"],
+  ["mermaid", "./mermaid.mjs"],
+  ["null", "./null.mjs"],
+  ["azure-devops", "./azure-devops.mjs"],
+]);
 
 /**
  * Returns the reporter function associated with given output type,
@@ -38,9 +38,7 @@ async function getReporter(pOutputType) {
   if (pOutputType?.startsWith("plugin:")) {
     lReturnValue = await getExternalPluginReporter(pOutputType);
   } else {
-    const lModuleToImport =
-      // eslint-disable-next-line security/detect-object-injection
-      TYPE2MODULE[pOutputType] || "./identity.mjs";
+    const lModuleToImport = TYPE2MODULE.get(pOutputType) ?? "./identity.mjs";
     const lModule = await import(lModuleToImport);
     lReturnValue = lModule.default;
   }
@@ -53,7 +51,7 @@ async function getReporter(pOutputType) {
  * @returns {import("../../types/shared-types.js").OutputType[]} -
  */
 function getAvailableReporters() {
-  return Object.keys(TYPE2MODULE);
+  return Array.from(TYPE2MODULE.keys());
 }
 
 export default {