dependency-cruiser 12.1.0 → 12.2.0

package/src/main/report-wrap.js

@@ -9,9 +9,9 @@ const report = require("../report");
 
 /**
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pResult
- * @param {import('../../types/dependency-cruiser').IFormatOptions} pFormatOptions
- * @returns {import('../../types/dependency-cruiser').ICruiseResult}
+ * @param {import('../..').ICruiseResult} pResult
+ * @param {import('../..').IFormatOptions} pFormatOptions
+ * @returns {import('../..').ICruiseResult}
  */
 function reSummarizeResults(pResult, pFormatOptions) {
   let lModules = filterBank.applyFilters(pResult.modules, pFormatOptions);
@@ -41,9 +41,9 @@ function reSummarizeResults(pResult, pFormatOptions) {
 }
 /**
  *
- * @param {import("../../types/dependency-cruiser").ICruiseResult} pResult result of a previous run of dependency-cruiser
- * @param {import("../../types/dependency-cruiser").IFormatOptions} pFormatOptions
- * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ * @param {import("../..).ICruiseResult} pResult result of a previous run of dependency-cruiser
+ * @param {import("../..").IFormatOptions} pFormatOptions
+ * @returns {import("../..").IReporterOutput}
  */
 module.exports = function reportWrap(pResult, pFormatOptions) {
   const lReportFunction = report.getReporter(pFormatOptions.outputType);

package/src/main/resolve-options/normalize.js

@@ -10,7 +10,7 @@ const {
 } = require("../../graph-utl/rule-set");
 
 const DEFAULT_CACHE_DURATION = 4000;
-/** @type {Partial<import("../../../types/dependency-cruiser").IResolveOptions>} */
+/** @type {Partial<import("../../..").IResolveOptions>} */
 const DEFAULT_RESOLVE_OPTIONS = {
   // for later: check semantics of enhanced-resolve symlinks and
   // node's preserveSymlinks. They seem to be
@@ -44,7 +44,7 @@ const DEFAULT_RESOLVE_OPTIONS = {
 /**
  *
  * @param {Number} pCacheDuration
- * @returns {Partial<import("../../../types/dependency-cruiser").IResolveOptions>}
+ * @returns {Partial<import("../../..").IResolveOptions>}
  */
 function getNonOverridableResolveOptions(pCacheDuration) {
   return {
@@ -120,8 +120,8 @@ function compileResolveOptions(
 }
 
 /**
- * @param {import("../../../types/dependency-cruiser").IResolveOptions} pResolveOptions
- * @param {import("../../../types/dependency-cruiser").ICruiseOptions} pOptions
+ * @param {import("../../..").IResolveOptions} pResolveOptions
+ * @param {import("../../..").ICruiseOptions} pOptions
  * @param {import("typescript").ParsedTsconfig} pTSConfig
  * @returns
  */

package/src/main/rule-set/normalize.js

@@ -55,7 +55,7 @@ function normalizeRule(pRule) {
  * - rule name (default 'unnamed')
  * - severity (default 'warn')
  *
- * @param  {import("../../../types/dependency-cruiser").IFlattenedRuleSet} pRuleSet
+ * @param  {import("../../..").IFlattenedRuleSet} pRuleSet
  * @return {import("../../../types/strict-rule-set").IStrictRuleSet}
  */
 module.exports = function normalizeRuleSet(pRuleSet) {

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "12.1.0",
+  version: "12.2.0",
   engines: {
     node: "^14||^16||>=18",
   },

package/src/report/anon/index.js

@@ -155,7 +155,7 @@ function sanitizeWordList(pWordList) {
  *                               not passed the reporter uses the string passed
  *                               in the options (reporterOptions.anon.wordlist)
  *                               or - if that doesn't exist - the empty array
- * @returns {import("../../../types/dependency-cruiser").IReporterOutput} - output: the results in JSON format (hence adhering to the same json schema)
+ * @returns {import("../../..").IReporterOutput} - output: the results in JSON format (hence adhering to the same json schema)
  *                              exitCode: 0
  */
 module.exports = function reportAnonymous(pResults, pAnonymousReporterOptions) {

package/src/report/baseline.js

@@ -3,18 +3,20 @@ const DEFAULT_JSON_INDENT = 2;
 /**
  * Sample plugin
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
+ * @param {import('../..').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @return {import('../..').IReporterOutput} -
  *      output: some stats on modules and dependencies in json format
  *      exitCode: 0
  */
-module.exports = (pCruiseResult) => ({
-  output: JSON.stringify(
-    pCruiseResult.summary.violations,
-    null,
-    DEFAULT_JSON_INDENT
-  ),
-  exitCode: 0,
-});
+module.exports = function baseline(pCruiseResult) {
+  return {
+    output: JSON.stringify(
+      pCruiseResult.summary.violations,
+      null,
+      DEFAULT_JSON_INDENT
+    ),
+    exitCode: 0,
+  };
+};

package/src/report/csv.js

@@ -25,9 +25,11 @@ function report(pModules) {
  *
  * @param {import("../../types/cruise-result").ICruiseResult} pResults -
  * the output of a dependency-cruise adhering to ../../schema/cruise-result.schema.json
- * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ * @returns {import("../..").IReporterOutput}
  */
-module.exports = (pResults) => ({
-  output: report(dependencyToIncidenceTransformer(pResults.modules)),
-  exitCode: 0,
-});
+module.exports = function csv(pResults) {
+  return {
+    output: report(dependencyToIncidenceTransformer(pResults.modules)),
+    exitCode: 0,
+  };
+};

package/src/report/dot/index.js

@@ -130,17 +130,19 @@ function normalizeDotReporterOptions(
  * @param {string} pGranularity - either "module" (for fine grained module
  *                                level) or "folder" (for a report consolidated
  *                                to folders)
- * @returns {(pResults, pDotReporterOptions) => import("../../../types/dependency-cruiser").IReporterOutput}
+ * @returns {(pResults, pDotReporterOptions) => import("../../..").IReporterOutput}
  */
-module.exports = (pGranularity) => (pResults, pDotReporterOptions) => {
-  const lDotReporterOptions = normalizeDotReporterOptions(
-    pDotReporterOptions,
-    pGranularity,
-    pResults
-  );
+module.exports = function produceDotReporter(pGranularity) {
+  return function dot(pResults, pDotReporterOptions) {
+    const lDotReporterOptions = normalizeDotReporterOptions(
+      pDotReporterOptions,
+      pGranularity,
+      pResults
+    );
 
-  return {
-    output: report(pResults, pGranularity, lDotReporterOptions),
-    exitCode: 0,
+    return {
+      output: report(pResults, pGranularity, lDotReporterOptions),
+      exitCode: 0,
+    };
   };
 };

package/src/report/dot/module-utl.js

@@ -67,9 +67,9 @@ function makeInstabilityString(pModule, pShowMetrics = false) {
   let lInstabilityString = "";
 
   if (pShowMetrics && has(pModule, "instability") && !pModule.consolidated) {
-    lInstabilityString = ` <FONT color="#808080" point-size="8">${utl.formatInstability(
+    lInstabilityString = ` <FONT color="#808080" point-size="8">${utl.formatPercentage(
       pModule.instability
-    )}%</FONT>`;
+    )}</FONT>`;
   }
   return lInstabilityString;
 }

package/src/report/dot/prepare-custom-level.js

@@ -4,7 +4,12 @@ const compare = require("../../graph-utl/compare");
 const stripSelfTransitions = require("../../graph-utl/strip-self-transitions");
 const moduleUtl = require("./module-utl");
 
-module.exports = (pResults, pTheme, pCollapsePattern, pShowMetrics) => {
+module.exports = function prepareCustomLevel(
+  pResults,
+  pTheme,
+  pCollapsePattern,
+  pShowMetrics
+) {
   return (
     pCollapsePattern
       ? consolidateToPattern(pResults.modules, pCollapsePattern)

package/src/report/dot/prepare-flat-level.js

@@ -2,7 +2,7 @@ const get = require("lodash/get");
 const compare = require("../../graph-utl/compare");
 const moduleUtl = require("./module-utl");
 
-module.exports = (pResults, pTheme, _, pShowMetrics) => {
+module.exports = function prepareFlatLevel(pResults, pTheme, _, pShowMetrics) {
   return pResults.modules
     .sort(compare.modules)
     .map(moduleUtl.flatLabel(pShowMetrics))

package/src/report/dot/prepare-folder-level.js

@@ -3,7 +3,12 @@ const compare = require("../../graph-utl/compare");
 const stripSelfTransitions = require("../../graph-utl/strip-self-transitions");
 const moduleUtl = require("./module-utl");
 
-module.exports = (pResults, pTheme, _, pShowMetrics) => {
+module.exports = function prepareFolderLevel(
+  pResults,
+  pTheme,
+  _,
+  pShowMetrics
+) {
   return consolidateToFolder(pResults.modules)
     .sort(compare.modules)
     .map(moduleUtl.extractFirstTransgression)

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

@@ -27,10 +27,12 @@ function report(pResults) {
  * Returns the results of a cruise in an 'incidence matrix'
  *
  * @param {import("../../../types/cruise-result").ICruiseResult} pResults - the output of a dependency-cruise adhering to ../../schema/cruise-result.schema.json
- * @returns {import("../../../types/dependency-cruiser").IReporterOutput} - output: an html program showing the summary & the violations (if any)
+ * @returns {import("../../..").IReporterOutput} - output: an html program showing the summary & the violations (if any)
  *                              exitCode: 0
  */
-module.exports = (pResults) => ({
-  output: report(pResults),
-  exitCode: 0,
-});
+module.exports = function errorHtml(pResults) {
+  return {
+    output: report(pResults),
+    exitCode: 0,
+  };
+};

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

@@ -1,6 +1,6 @@
 const has = require("lodash/has");
 const { version } = require("../../../src/meta.js");
-const { formatViolation, formatInstability } = require("../utl/index.js");
+const { formatViolation, formatPercentage } = require("../utl/index.js");
 
 function getFormattedAllowedRule(pRuleSetUsed) {
   const lAllowed = pRuleSetUsed?.allowed ?? [];
@@ -46,9 +46,9 @@ function formatModuleTo() {
 }
 
 function formatInstabilityTo(pViolation) {
-  return `${pViolation.to}&nbsp;<span class="extra">(I: ${formatInstability(
+  return `${pViolation.to}&nbsp;<span class="extra">(I: ${formatPercentage(
     pViolation.metrics.to.instability
-  )}%)</span>`;
+  )})</span>`;
 }
 
 function determineTo(pViolation) {
@@ -67,9 +67,9 @@ function determineTo(pViolation) {
 }
 
 function formatInstabilityFromExtras(pViolation) {
-  return `&nbsp;<span class="extra">(I: ${formatInstability(
+  return `&nbsp;<span class="extra">(I: ${formatPercentage(
     pViolation.metrics.from.instability
-  )}%)</span>`;
+  )})</span>`;
 }
 
 function determineFromExtras(pViolation) {

package/src/report/error.js

@@ -47,11 +47,11 @@ function formatReachabilityViolation(pViolation) {
 function formatInstabilityViolation(pViolation) {
   return `${formatDependencyViolation(pViolation)}\n${wrapAndIndent(
     chalk.dim(
-      `instability: ${utl.formatInstability(
+      `instability: ${utl.formatPercentage(
         pViolation.metrics.from.instability
-      )}% ${figures.arrowRight} ${utl.formatInstability(
+      )} ${figures.arrowRight} ${utl.formatPercentage(
         pViolation.metrics.to.instability
-      )}%`
+      )}`
     ),
     EXTRA_PATH_INFORMATION_INDENT
   )}`;
@@ -153,10 +153,12 @@ function report(pResults, pLong) {
  * @param {any} pOptions - An object with options;
  *                         {boolean} long - whether or not to include an explanation
  *                                          (/ comment) which each violation
- * @returns {import("../../types/dependency-cruiser").IReporterOutput} - output: the formatted text in a string
+ * @returns {import("../..").IReporterOutput} - output: the formatted text in a string
  *                              exitCode: the number of errors found
  */
-module.exports = (pResults, pOptions) => ({
-  output: report(pResults, (pOptions || {}).long),
-  exitCode: pResults.summary.error,
-});
+module.exports = function error(pResults, pOptions) {
+  return {
+    output: report(pResults, (pOptions || {}).long),
+    exitCode: pResults.summary.error,
+  };
+};

package/src/report/html/index.js

@@ -26,9 +26,11 @@ function report(pResults) {
  * Returns the results of a cruise in an 'incidence matrix'
  *
  * @param {import("../../../types/cruise-result").ICruiseResult} pResults
- * @returns {import("../../../types/dependency-cruiser").IReporterOutput}
+ * @returns {import("../../..").IReporterOutput}
  */
-module.exports = (pResults) => ({
-  output: report(pResults),
-  exitCode: 0,
-});
+module.exports = function html(pResults) {
+  return {
+    output: report(pResults),
+    exitCode: 0,
+  };
+};

package/src/report/identity.js

@@ -2,9 +2,11 @@
  * Returns the results of a cruise in a javascript object
  *
  * @param {import("../../types/cruise-result").ICruiseResult} pResults
- * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ * @returns {import("../..").IReporterOutput}
  */
-module.exports = (pResults) => ({
-  output: pResults,
-  exitCode: 0,
-});
+module.exports = function identity(pResults) {
+  return {
+    output: pResults,
+    exitCode: 0,
+  };
+};

package/src/report/json.js

@@ -2,9 +2,11 @@
  * Returns the results of a cruise in JSON
  *
  * @param {import("../../types/cruise-result").ICruiseResult} pResults
- * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ * @returns {import("../..").IReporterOutput}
  */
-module.exports = (pResults) => ({
-  output: JSON.stringify(pResults, null, "  "),
-  exitCode: 0,
-});
+module.exports = function json(pResults) {
+  return {
+    output: JSON.stringify(pResults, null, "  "),
+    exitCode: 0,
+  };
+};

package/src/report/markdown.js

@@ -73,9 +73,9 @@ function formatRulesSummary(pCruiseResult, pIncludeIgnoredInSummary) {
     )
     .reduce(
       (pAll, pRule) =>
-        (pAll += `|${severity2Icon(pRule.severity)} _${pRule.name}_|**${
+        `${pAll}|${severity2Icon(pRule.severity)} _${pRule.name}_|**${
           pRule.count
-        }**|**${pRule.ignoredCount}**|${pRule.comment}|\n`),
+        }**|**${pRule.ignoredCount}**|${pRule.comment}|\n`,
       lTableHead
     );
 }
@@ -164,9 +164,11 @@ function report(pResults, pOptions) {
  *
  * @param {import("../../types/cruise-result").ICruiseResult} pResults
  * @param {import("../../types/reporter-options").IMarkdownReporterOptions} pOptions
- * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ * @returns {import("../..").IReporterOutput}
  */
-module.exports = (pResults, pOptions) => ({
-  output: report(pResults, pOptions),
-  exitCode: 0,
-});
+module.exports = function markdown(pResults, pOptions) {
+  return {
+    output: report(pResults, pOptions),
+    exitCode: 0,
+  };
+};

package/src/report/mermaid.js

@@ -4,7 +4,8 @@ const REPORT_DEFAULTS = {
   minify: true,
 };
 
-const renderNode = (pNode, pText) => `${pNode}["${pText}"]`;
+const renderNode = (pNode, pText) =>
+  `${pNode}["${pText.length > 0 ? pText : " "}"]`;
 
 const renderEdge = (pFrom, pTo) => `${pFrom.node}-->${pTo.node}`;
 
@@ -12,7 +13,7 @@ const renderEdges = (pEdges) =>
   pEdges.map((pEdge) => renderEdge(pEdge.from, pEdge.to)).join("\n");
 
 /**
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
+ * @param {import('../..').ICruiseResult} pCruiseResult
  * @param {Map<string, string>} pNamesHashMap
  */
 function convertEdgeSources(pCruiseResult, pNamesHashMap) {
@@ -58,7 +59,7 @@ function renderSubgraphs(pSource, pOptions, pDepth = 0) {
 }
 
 /**
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
+ * @param {import('../..').ICruiseResult} pCruiseResult
  * @param {Map<string, string>} pNamesHashMap
  */
 function convertSubgraphSources(pCruiseResult, pNamesHashMap) {
@@ -99,7 +100,7 @@ function focusHighlights(pModules, pNamesHashMap) {
     )
     .reduce((pAll, pModule) => {
       const lSource = pNamesHashMap.get(pModule.source);
-      return (pAll += `\nstyle ${lSource} ${lHighLightStyle}`);
+      return `${pAll}\nstyle ${lSource} ${lHighLightStyle}`;
     }, "");
 }
 
@@ -140,7 +141,7 @@ function hashModuleNames(pModules, pMinify) {
 }
 
 /**
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
+ * @param {import('../..').ICruiseResult} pCruiseResult
  * @param {import("../../types/reporter-options").IMermaidReporterOptions} pOptions
  */
 function renderMermaidSource(pCruiseResult, pOptions) {
@@ -159,11 +160,13 @@ ${focusHighlights(pCruiseResult.modules, lNamesHashMap)}`;
 /**
  * mermaid reporter
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
+ * @param {import('../..').ICruiseResult} pCruiseResult
  * @param {import("../../types/reporter-options").IMermaidReporterOptions} pOptions
- * @return {import('../../types/dependency-cruiser').IReporterOutput}
+ * @return {import('../..').IReporterOutput}
  */
-module.exports = (pCruiseResult, pOptions) => ({
-  output: renderMermaidSource(pCruiseResult, pOptions),
-  exitCode: 0,
-});
+module.exports = function mermaid(pCruiseResult, pOptions) {
+  return {
+    output: renderMermaidSource(pCruiseResult, pOptions),
+    exitCode: 0,
+  };
+};

package/src/report/metrics.js

@@ -3,7 +3,7 @@ const chalk = require("chalk");
 const utl = require("./utl");
 
 const DECIMAL_BASE = 10;
-const METRIC_WIDTH = 4;
+const METRIC_WIDTH = 5;
 const COMPONENT_HEADER = "name";
 
 function getHeader(pMaxNameWidth) {
@@ -11,7 +11,7 @@ function getHeader(pMaxNameWidth) {
     METRIC_WIDTH + 1
   )} ${"Ca".padStart(METRIC_WIDTH + 1)} ${"Ce".padStart(
     METRIC_WIDTH + 1
-  )}  ${"I (%)".padEnd(METRIC_WIDTH + 1)}`;
+  )} ${"I (%)".padStart(METRIC_WIDTH + 1)}`;
 }
 
 function getDemarcationLine(pMaxNameWidth) {
@@ -19,7 +19,7 @@ function getDemarcationLine(pMaxNameWidth) {
     METRIC_WIDTH + 1
   )} ${"-".repeat(METRIC_WIDTH + 1)} ${"-".repeat(
     METRIC_WIDTH + 1
-  )}  ${"-".repeat(METRIC_WIDTH + 1)}`;
+  )} ${"-".repeat(METRIC_WIDTH + 1)}`;
 }
 
 function getMetricsTable(pMetrics, pMaxNameWidth) {
@@ -38,8 +38,7 @@ function getMetricsTable(pMetrics, pMaxNameWidth) {
         .padStart(METRIC_WIDTH)}  ${efferentCouplings
         .toString(DECIMAL_BASE)
         .padStart(METRIC_WIDTH)}  ${utl
-        .formatInstability(instability)
-        .toString(DECIMAL_BASE)
+        .formatPercentage(instability)
         .padStart(METRIC_WIDTH)}`
   );
 }
@@ -113,11 +112,11 @@ function transformMetricsToTable(
  * Potential future features:
  * - additional output formats (csv?, html?)
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
+ * @param {import('../..').ICruiseResult} pCruiseResult -
  * @param {import("../../types/reporter-options").IMetricsReporterOptions} pReporterOptions
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @return {import('../..').IReporterOutput} -
  */
-module.exports = (pCruiseResult, pReporterOptions) => {
+module.exports = function metrics(pCruiseResult, pReporterOptions) {
   const lReporterOptions = pReporterOptions || {};
   if (pCruiseResult.folders) {
     return {

package/src/report/{plugins/index.js → plugins.js}

@@ -2,13 +2,14 @@ const has = require("lodash/has");
 
 function isValidPlugin(pPluginFunction) {
   let lReturnValue = false;
-  /** @type {import('../../../types/dependency-cruiser').ICruiseResult} */
+  /** @type {import('../..').ICruiseResult} */
   const lMinimalCruiseResult = {
     modules: [],
     summary: {
       error: 0,
       info: 0,
       warn: 0,
+      ignore: 0,
       totalCruised: 0,
       violations: [],
       optionsUsed: {},
@@ -32,7 +33,9 @@ function getPluginReporter(pOutputType) {
     // eslint-disable-next-line import/no-dynamic-require, node/global-require, security/detect-non-literal-require
     lReturnValue = require(pOutputType);
   } catch (pError) {
-    throw new Error(`Could not find reporter plugin '${pOutputType}'`);
+    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`);

package/src/report/teamcity.js

@@ -89,9 +89,9 @@ function formatReachabilityViolation(pViolation) {
 function formatInstabilityViolation(pViolation) {
   return `${formatDependencyViolation(
     pViolation
-  )} (instability: ${utl.formatInstability(
+  )} (instability: ${utl.formatPercentage(
     pViolation.metrics.from.instability
-  )}% -> ${utl.formatInstability(pViolation.metrics.to.instability)}%)`;
+  )} -> ${utl.formatPercentage(pViolation.metrics.to.instability)})`;
 }
 
 function bakeViolationMessage(pViolation) {
@@ -140,10 +140,10 @@ function reportViolations(pViolations, pIgnoredCount) {
  * - for each violated rule in the passed results: an `inspectionType` with the name and comment of that rule
  * - for each violation in the passed results: an `inspection` with the violated rule name and the tos and froms
  *
- * @param {import("../../types/dependency-cruiser").ICruiseResult} pResults
- * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ * @param {import("../..").ICruiseResult} pResults
+ * @returns {import("../..").IReporterOutput}
  */
-module.exports = (pResults) => {
+module.exports = function teamcity(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.

package/src/report/text.js

@@ -82,9 +82,11 @@ function report(pResults, pOptions) {
  * - for each dependency the from and the two, separated by an arrow.
  * @param {import("../../types/cruise-result").ICruiseResult} pResults
  * @param {import("../../types/reporter-options").ITextReporterOptions} pOptions
- * @returns {import("../../types/dependency-cruiser").IReporterOutput}
+ * @returns {import("../..").IReporterOutput}
  */
-module.exports = (pResults, pOptions) => ({
-  output: report(pResults, pOptions || {}),
-  exitCode: 0,
-});
+module.exports = function text(pResults, pOptions) {
+  return {
+    output: report(pResults, pOptions || {}),
+    exitCode: 0,
+  };
+};

package/src/report/utl/dependency-to-incidence-transformer.js

@@ -45,5 +45,6 @@ function addIncidences(pFromList) {
 /*
 
 */
-module.exports = (pFromList) =>
-  pFromList.sort(compareOnSource).map(addIncidences(pFromList));
+module.exports = function transformDependenciesToIncidences(pFromList) {
+  return pFromList.sort(compareOnSource).map(addIncidences(pFromList));
+};

package/src/report/utl/index.js

@@ -1,7 +1,6 @@
-function formatInstability(pNumber) {
-  // eslint-disable-next-line no-magic-numbers
-  return Math.round(100 * pNumber);
-}
+// eslint-disable-next-line no-undefined
+const formatPercentage = new Intl.NumberFormat(undefined, { style: "percent" })
+  .format;
 
 function formatViolation(
   pViolation,
@@ -13,4 +12,4 @@ function formatViolation(
   );
 }
 
-module.exports = { formatViolation, formatInstability };
+module.exports = { formatViolation, formatPercentage };

package/src/validate/match-dependency-rule.js

@@ -4,8 +4,8 @@ const matchers = require("./matchers");
 
 /**
  *
- * @param {import("../../types/dependency-cruiser").IModule} pFrom
- * @param {import("../../types/dependency-cruiser").IDependency} pTo
+ * @param {import("../..").IModule} pFrom
+ * @param {import("../..").IDependency} pTo
  * @returns {(pRule) => boolean}
  */
 function match(pFrom, pTo) {

package/types/README.md

@@ -0,0 +1 @@
+![overview](overview.svg)