dependency-cruiser 13.0.0-beta-5 → 13.0.0-beta-7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "13.0.0-beta-5",
+  "version": "13.0.0-beta-7",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -169,19 +169,19 @@
     "semver-try-require": "6.2.2",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.0.1",
-    "watskeburt": "0.10.2",
+    "watskeburt": "0.11.1",
     "wrap-ansi": "8.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.21.4",
-    "@babel/plugin-transform-modules-commonjs": "7.21.2",
-    "@babel/preset-typescript": "7.21.4",
-    "@swc/core": "1.3.53",
+    "@babel/core": "7.21.5",
+    "@babel/plugin-transform-modules-commonjs": "7.21.5",
+    "@babel/preset-typescript": "7.21.5",
+    "@swc/core": "1.3.55",
     "@types/lodash": "4.14.194",
-    "@types/node": "18.16.0",
+    "@types/node": "18.16.3",
     "@types/prompts": "2.4.4",
-    "@typescript-eslint/eslint-plugin": "5.59.0",
-    "@typescript-eslint/parser": "5.59.0",
+    "@typescript-eslint/eslint-plugin": "5.59.1",
+    "@typescript-eslint/parser": "5.59.1",
     "@vue/compiler-sfc": "3.2.47",
     "c8": "7.13.0",
     "chai": "4.3.7",
@@ -199,7 +199,7 @@
     "eslint-plugin-unicorn": "^46.0.0",
     "husky": "8.0.3",
     "intercept-stdout": "0.1.2",
-    "lint-staged": "13.2.1",
+    "lint-staged": "13.2.2",
     "mocha": "10.2.0",
     "normalize-newline": "4.1.0",
     "npm-run-all": "4.1.5",

package/src/cache/cache.mjs

@@ -1,6 +1,7 @@
-import { readFileSync, mkdirSync, writeFileSync } from "node:fs";
+import { readFile, mkdir, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 import { scannableExtensions } from "../extract/transpile/meta.mjs";
+import { bus } from "../utl/bus.mjs";
 import { optionsAreCompatible } from "./options-compatible.mjs";
 import MetadataStrategy from "./metadata-strategy.mjs";
 import ContentStrategy from "./content-strategy.mjs";
@@ -25,10 +26,10 @@ export default class Cache {
    * @param {import("../../types/dependency-cruiser.js").IRevisionData=} pRevisionData
    * @returns {boolean}
    */
-  canServeFromCache(pCruiseOptions, pCachedCruiseResult, pRevisionData) {
+  async canServeFromCache(pCruiseOptions, pCachedCruiseResult, pRevisionData) {
     this.revisionData =
       pRevisionData ??
-      this.cacheStrategy.getRevisionData(
+      (await this.cacheStrategy.getRevisionData(
         ".",
         pCachedCruiseResult,
         pCruiseOptions,
@@ -37,7 +38,8 @@ export default class Cache {
             scannableExtensions.concat(pCruiseOptions.extraExtensionsToScan)
           ),
         }
-      );
+      ));
+    bus.debug("cache: - comparing");
     return (
       this.cacheStrategy.revisionDataEqual(
         pCachedCruiseResult.revisionData,
@@ -54,10 +56,10 @@ export default class Cache {
    * @param {string} pCacheFolder
    * @returns {import("../../types/dependency-cruiser.js").ICruiseResult}
    */
-  read(pCacheFolder) {
+  async read(pCacheFolder) {
     try {
       return JSON.parse(
-        readFileSync(join(pCacheFolder, CACHE_FILE_NAME), "utf8")
+        await readFile(join(pCacheFolder, CACHE_FILE_NAME), "utf8")
       );
     } catch (pError) {
       return { modules: [], summary: {} };
@@ -69,11 +71,11 @@ export default class Cache {
    * @param {import("../../types/dependency-cruiser.js").ICruiseResult} pCruiseResult
    * @param {import("../../types/dependency-cruiser.js").IRevisionData=} pRevisionData
    */
-  write(pCacheFolder, pCruiseResult, pRevisionData) {
+  async write(pCacheFolder, pCruiseResult, pRevisionData) {
     const lRevisionData = pRevisionData ?? this.revisionData;
 
-    mkdirSync(pCacheFolder, { recursive: true });
-    writeFileSync(
+    await mkdir(pCacheFolder, { recursive: true });
+    await writeFile(
       join(pCacheFolder, CACHE_FILE_NAME),
       JSON.stringify(
         this.cacheStrategy.prepareRevisionDataForSaving(

package/src/cache/content-strategy.mjs

@@ -2,9 +2,8 @@ import { isDeepStrictEqual } from "node:util";
 import { join } from "node:path/posix";
 import findContentChanges from "./find-content-changes.mjs";
 import {
-  getFileHash,
+  getFileHashSync,
   isInterestingChangeType,
-  addCheckSumToChange,
   moduleIsInterestingForDiff,
 } from "./helpers.mjs";
 
@@ -17,7 +16,7 @@ function addCheckSumToModule(pBaseDirectory) {
     if (moduleIsInterestingForDiff(pModule)) {
       return {
         ...pModule,
-        checksum: getFileHash(join(pBaseDirectory, pModule.source)),
+        checksum: getFileHashSync(join(pBaseDirectory, pModule.source)),
       };
     }
     return pModule;
@@ -56,7 +55,6 @@ export default class ContentStrategy {
   getRevisionData(pDirectory, pCachedCruiseResult, pCruiseOptions, pOptions) {
     const lOptions = {
       diffListFn: findContentChanges,
-      checksumFn: addCheckSumToChange,
       baseDir: process.cwd(),
       ...pOptions,
     };

package/src/cache/find-content-changes.mjs

@@ -1,26 +1,23 @@
 import { join } from "node:path/posix";
-import bus from "../utl/bus.mjs";
-import busLogLevels from "../utl/bus-log-levels.mjs";
+import { bus } from "../utl/bus.mjs";
 import findAllFiles from "../utl/find-all-files.mjs";
 import {
-  getFileHash,
+  getFileHashSync,
   excludeFilter,
   includeOnlyFilter,
   hasInterestingExtension,
   moduleIsInterestingForDiff,
 } from "./helpers.mjs";
 
-const { DEBUG } = busLogLevels;
-
 /**
  * @param {Set<string>} pFileSet
- * @param {typeof getFileHash} pFileHashFunction
+ * @param {typeof getFileHashSync} pFileHashFunction
  * @returns {(pModule:import("../..").IModule) => import('../..').IRevisionChange}
  */
 function diffCachedModuleAgainstFileSet(
   pFileSet,
   pBaseDirectory,
-  pFileHashFunction = getFileHash
+  pFileHashFunction = getFileHashSync
 ) {
   return (pModule) => {
     if (!moduleIsInterestingForDiff(pModule)) {
@@ -75,7 +72,7 @@ export default function findContentChanges(
   pCachedCruiseResult,
   pOptions
 ) {
-  bus.emit("progress", "cache: - hauling revision data", { level: DEBUG });
+  bus.debug("cache: - getting revision data");
   const lFileSet = new Set(
     findAllFiles(pDirectory, {
       baseDir: pOptions.baseDir,
@@ -84,12 +81,12 @@ export default function findContentChanges(
     }).filter(hasInterestingExtension(pOptions.extensions))
   );
 
-  bus.emit("progress", "cache: - determining cached vs new", { level: DEBUG });
+  bus.debug("cache: - getting (cached - new)");
   const lDiffCachedVsNew = pCachedCruiseResult.modules.map(
     diffCachedModuleAgainstFileSet(lFileSet, pOptions.baseDir)
   );
 
-  bus.emit("progress", "cache: - determining new vs cached", { level: DEBUG });
+  bus.debug("cache: - getting (new - cached)");
   lDiffCachedVsNew.forEach(({ name }) => lFileSet.delete(name));
 
   const lDiffNewVsCached = [];
@@ -97,10 +94,10 @@ export default function findContentChanges(
     lDiffNewVsCached.push({
       name: lFileName,
       changeType: "added",
-      checksum: getFileHash(join(pOptions.baseDir, lFileName)),
+      checksum: getFileHashSync(join(pOptions.baseDir, lFileName)),
     });
   }
 
-  bus.emit("progress", "cache: - returning revision data", { level: DEBUG });
+  bus.debug("cache: - returning revision data");
   return lDiffCachedVsNew.concat(lDiffNewVsCached);
 }

package/src/cache/helpers.mjs

@@ -1,6 +1,7 @@
 /* eslint-disable import/exports-last */
 import { createHash } from "node:crypto";
 import { readFileSync } from "node:fs";
+import { readFile } from "node:fs/promises";
 import { extname } from "node:path";
 import memoize from "lodash/memoize.js";
 import { filenameMatchesPattern } from "../graph-utl/match-facade.mjs";
@@ -13,11 +14,32 @@ function hash(pString) {
   return createHash("sha1").update(pString).digest("base64");
 }
 
+/**
+ * @param {import("fs").PathOrFileDescriptor} pFileName
+ * @returns {Promise<string>}
+ */
+async function _getFileHash(pFileName) {
+  try {
+    return hash(await readFile(pFileName, "utf8"));
+  } catch (pError) {
+    return "file not found";
+  }
+}
+
+export const getFileHash = memoize(_getFileHash);
+
+export async function addCheckSumToChange(pChange) {
+  return {
+    ...pChange,
+    checksum: await getFileHash(pChange.name),
+  };
+}
+
 /**
  * @param {import("fs").PathOrFileDescriptor} pFileName
  * @returns {string}
  */
-function _getFileHash(pFileName) {
+function _getFileHashSync(pFileName) {
   try {
     return hash(readFileSync(pFileName, "utf8"));
   } catch (pError) {
@@ -25,16 +47,16 @@ function _getFileHash(pFileName) {
   }
 }
 
-export const getFileHash = memoize(_getFileHash);
+export const getFileHashSync = memoize(_getFileHashSync);
 
 /**
  * @param {import("watskeburt").IChange} pChange
  * @param {import("../../types/dependency-cruiser.js").IRevisionChange}
  */
-export function addCheckSumToChange(pChange) {
+export function addCheckSumToChangeSync(pChange) {
   return {
     ...pChange,
-    checksum: getFileHash(pChange.name),
+    checksum: getFileHashSync(pChange.name),
   };
 }
 

package/src/cache/metadata-strategy.mjs

@@ -1,8 +1,9 @@
 import { isDeepStrictEqual } from "node:util";
-import { getSHASync, listSync } from "watskeburt";
+import { getSHA, list } from "watskeburt";
+import { bus } from "../utl/bus.mjs";
 import {
   isInterestingChangeType,
-  addCheckSumToChange,
+  addCheckSumToChangeSync,
   excludeFilter,
   includeOnlyFilter,
   changeHasInterestingExtension,
@@ -21,26 +22,34 @@ export default class MetaDataStrategy {
    * @param {(import("watskeburt").IChange) => import("../..").IRevisionChange} pOptions.checksumFn
    * @returns {import("../../types/dependency-cruiser.js").IRevisionData}
    */
-  getRevisionData(pDirectory, pCachedCruiseResult, pCruiseOptions, pOptions) {
+  async getRevisionData(
+    pDirectory,
+    pCachedCruiseResult,
+    pCruiseOptions,
+    pOptions
+  ) {
     const lOptions = {
-      shaRetrievalFn: getSHASync,
-      diffListFn: listSync,
-      checksumFn: addCheckSumToChange,
+      shaRetrievalFn: getSHA,
+      diffListFn: list,
+      checksumFn: addCheckSumToChangeSync,
       ...pOptions,
     };
     try {
-      const lSHA = lOptions.shaRetrievalFn();
+      bus.debug("cache: - getting sha");
+      const lSHA = await lOptions.shaRetrievalFn();
+      bus.debug("cache: - getting diff");
+      const lDiff = await lOptions.diffListFn(lSHA);
+      const lChanges = lDiff
+        .filter(({ name }) => excludeFilter(pCruiseOptions.exclude)(name))
+        .filter(({ name }) =>
+          includeOnlyFilter(pCruiseOptions.includeOnly)(name)
+        )
+        .filter(changeHasInterestingExtension(lOptions.extensions))
+        .filter(isInterestingChangeType(lOptions.interestingChangeTypes));
+      bus.debug("cache: - sha-summing diff");
       return {
         SHA1: lSHA,
-        changes: lOptions
-          .diffListFn(lSHA)
-          .filter(({ name }) => excludeFilter(pCruiseOptions.exclude)(name))
-          .filter(({ name }) =>
-            includeOnlyFilter(pCruiseOptions.includeOnly)(name)
-          )
-          .filter(changeHasInterestingExtension(lOptions.extensions))
-          .filter(isInterestingChangeType(lOptions.interestingChangeTypes))
-          .map(lOptions.checksumFn),
+        changes: lChanges.map(lOptions.checksumFn),
       };
     } catch (pError) {
       throw new Error(

package/src/cache/options-compatible.mjs

@@ -117,8 +117,8 @@ export function optionsAreCompatible(pOldOptions, pNewOptions) {
     filterOptionIsCompatible(pOldOptions.collapse, pNewOptions.collapse) &&
     limitIsCompatible(pOldOptions.maxDepth, pNewOptions.maxDepth) &&
     optionIsCompatible(
-      pOldOptions.knownViolations,
-      pNewOptions.knownViolations
+      pOldOptions.knownViolations || [],
+      pNewOptions.knownViolations || []
     ) &&
     optionIsCompatible(
       pOldOptions.enhancedResolveOptions,

package/src/cli/index.mjs

@@ -1,4 +1,3 @@
-/* eslint-disable import/max-dependencies */
 import { join } from "node:path";
 import { glob } from "glob";
 import cloneDeep from "lodash/cloneDeep.js";
@@ -7,9 +6,8 @@ import isInstalledGlobally from "is-installed-globally";
 import chalk from "chalk";
 
 import cruise from "../main/cruise.mjs";
-import bus from "../utl/bus.mjs";
+import { INFO, bus } from "../utl/bus.mjs";
 
-import busLogLevels from "../utl/bus-log-levels.mjs";
 import validateFileExistence from "./utl/validate-file-existence.mjs";
 import normalizeCliOptions from "./normalize-cli-options.mjs";
 import { write } from "./utl/io.mjs";
@@ -97,8 +95,7 @@ function setUpListener(pCruiseOptions) {
   if (Boolean(lListenerFunction)) {
     lListenerFunction(
       bus,
-      pCruiseOptions?.ruleSet?.options?.progress?.maximumLevel ??
-        busLogLevels.INFO
+      pCruiseOptions?.ruleSet?.options?.progress?.maximumLevel ?? INFO
     );
   }
 }
@@ -132,7 +129,7 @@ async function runCruise(pFileDirectoryArray, pCruiseOptions) {
     { tsConfig, babelConfig }
   );
 
-  bus.emit("progress", "cli: writing results", { complete: 1 });
+  bus.progress("cli: writing results", { complete: 1 });
   bus.emit("write-start");
   write(lCruiseOptions.outputTo, lReportingResult.output);
 

package/src/cli/listeners/cli-feedback.mjs

@@ -1,6 +1,6 @@
 import chalk from "chalk";
 import figures from "figures";
-import busLogLevels from "../../utl/bus-log-levels.mjs";
+import { SUMMARY } from "../../utl/bus.mjs";
 
 const FULL_ON = 100;
 
@@ -26,7 +26,7 @@ function getPercentageBar(pPercentage, pParameters) {
 function getProgressMessageWriter(pStream, pState, pMaxLogLevel) {
   return (pMessage, pOptions) => {
     const lOptions = {
-      level: busLogLevels.SUMMARY,
+      level: SUMMARY,
       complete: pState.complete,
       ...(pOptions || {}),
     };
@@ -56,7 +56,7 @@ function getStartWriter(pStream) {
 
 export default function setUpCliFeedbackListener(
   pEventEmitter,
-  pMaxLogLevel = busLogLevels.SUMMARY,
+  pMaxLogLevel = SUMMARY,
   pStream = process.stderr
 ) {
   const lState = {

package/src/cli/listeners/ndjson.mjs

@@ -1,5 +1,5 @@
 import { EOL } from "node:os";
-import busLogLevels from "../../utl/bus-log-levels.mjs";
+import { INFO, SUMMARY } from "../../utl/bus.mjs";
 
 const MICRO_SECONDS_PER_SECOND = 1000000;
 
@@ -63,7 +63,7 @@ function getProgressLine(pMessage, pState, pLevel, pMaxLevel) {
 
 function getProgressWriter(pStream, pState, pMaxLevel) {
   return (pMessage, pOptions) => {
-    const lOptions = { level: busLogLevels.SUMMARY, ...(pOptions || {}) };
+    const lOptions = { level: SUMMARY, ...(pOptions || {}) };
 
     pStream.write(getProgressLine(pMessage, pState, lOptions.level, pMaxLevel));
   };
@@ -71,12 +71,12 @@ function getProgressWriter(pStream, pState, pMaxLevel) {
 
 export default function setUpNDJSONListener(
   pEventEmitter,
-  pMaxLevel = busLogLevels.INFO,
+  pMaxLevel = INFO,
   pStream = process.stderr
 ) {
   let lState = {
     runStartTime: new Date(Date.now()).toISOString(),
-    previousMessage: "start of node process",
+    previousMessage: "nodejs starting",
     previousTime: 0,
     previousUserUsage: 0,
     previousSystemUsage: 0,

package/src/cli/listeners/performance-log/format-helpers.mjs

@@ -38,13 +38,13 @@ export function formatHeader() {
   return chalk
     .bold(
       `${
-        pad("elapsed real") +
-        pad("user") +
-        pad("system") +
         pad("∆ rss") +
         pad("∆ heapTotal") +
         pad("∆ heapUsed") +
-        pad("∆ external")
+        pad("∆ external") +
+        pad("⏱ system") +
+        pad("⏱ user") +
+        pad("⏱ real")
       }after step...\n`
     )
     .concat(formatDividerLine());
@@ -73,13 +73,13 @@ export function formatPerfLine({
   message,
 }) {
   return `${
-    formatTime(elapsedTime) +
-    formatTime(elapsedUser, MS_PER_MICRO_SECOND) +
-    formatTime(elapsedSystem, MS_PER_MICRO_SECOND) +
     formatMemory(deltaRss) +
     formatMemory(deltaHeapTotal) +
     formatMemory(deltaHeapUsed) +
     formatMemory(deltaExternal) +
+    formatTime(elapsedSystem, MS_PER_MICRO_SECOND) +
+    formatTime(elapsedUser, MS_PER_MICRO_SECOND) +
+    formatTime(elapsedTime) +
     message
   }\n`;
 }

package/src/cli/listeners/performance-log/index.mjs

@@ -1,12 +1,9 @@
-import chalk from "chalk";
-import busLogLevels from "../../../utl/bus-log-levels.mjs";
+import { INFO, SUMMARY } from "../../../utl/bus.mjs";
 import { getHeader, getProgressLine, getEndText } from "./handlers.mjs";
 
-let gUnderline = false;
-
 function getHeaderWriter(pStream, pMaxLevel) {
   return (_pMessage, pOptions) => {
-    const lOptions = { level: busLogLevels.SUMMARY, ...(pOptions || {}) };
+    const lOptions = { level: SUMMARY, ...(pOptions || {}) };
 
     pStream.write(getHeader(lOptions.level, pMaxLevel));
   };
@@ -14,22 +11,19 @@ function getHeaderWriter(pStream, pMaxLevel) {
 
 function getProgressWriter(pStream, pState, pMaxLevel) {
   return (pMessage, pOptions) => {
-    const lOptions = { level: busLogLevels.SUMMARY, ...(pOptions || {}) };
+    const lOptions = { level: SUMMARY, ...(pOptions || {}) };
     const lProgressLine = getProgressLine(
       pMessage,
       pState,
       lOptions.level,
       pMaxLevel
     );
-    pStream.write(
-      gUnderline ? `${chalk.underline(lProgressLine)}` : lProgressLine
-    );
-    gUnderline = !gUnderline;
+    pStream.write(lProgressLine);
   };
 }
 
 function getEndWriter(pStream, pState, pMaxLevel) {
-  return (_pMessage, pLevel = busLogLevels.SUMMARY) => {
+  return (_pMessage, pLevel = SUMMARY) => {
     pStream.write(getEndText(pState, pLevel, pMaxLevel));
     pStream.end();
   };
@@ -37,11 +31,11 @@ function getEndWriter(pStream, pState, pMaxLevel) {
 
 export default function setUpPerformanceLogListener(
   pEventEmitter,
-  pMaxLevel = busLogLevels.INFO,
+  pMaxLevel = INFO,
   pStream = process.stderr
 ) {
   let lState = {
-    previousMessage: "start of node process",
+    previousMessage: "nodejs starting",
     previousTime: 0,
     previousUserUsage: 0,
     previousSystemUsage: 0,

package/src/enrich/enrich-modules.mjs

@@ -1,5 +1,4 @@
-import bus from "../utl/bus.mjs";
-import busLogLevels from "../utl/bus-log-levels.mjs";
+import { bus } from "../utl/bus.mjs";
 import addFocus from "../graph-utl/add-focus.mjs";
 import IndexedModuleGraph from "../graph-utl/indexed-module-graph.mjs";
 import deriveCycles from "./derive/circular.mjs";
@@ -11,31 +10,27 @@ import softenKnownViolations from "./soften-known-violations.mjs";
 import deriveModuleMetrics from "./derive/metrics/index.mjs";
 
 export default function enrichModules(pModules, pOptions) {
-  bus.emit("progress", "analyzing: cycles", { level: busLogLevels.INFO });
+  bus.info("analyzing: cycles");
   const lIndexedModules = new IndexedModuleGraph(pModules);
   let lModules = deriveCycles(pModules, lIndexedModules, {
     pSourceAttribute: "source",
     pDependencyName: "resolved",
   });
-  bus.emit("progress", "analyzing: dependents", { level: busLogLevels.INFO });
+  bus.info("analyzing: dependents");
   lModules = addDependents(lModules);
-  bus.emit("progress", "analyzing: orphans", { level: busLogLevels.INFO });
+  bus.info("analyzing: orphans");
   lModules = deriveOrphans(lModules);
-  bus.emit("progress", "analyzing: reachables", { level: busLogLevels.INFO });
+  bus.info("analyzing: reachables");
   lModules = deriveReachable(lModules, pOptions.ruleSet);
-  bus.emit("progress", "analyzing: module metrics", {
-    level: busLogLevels.INFO,
-  });
+  bus.info("analyzing: module metrics");
   lModules = deriveModuleMetrics(lModules, pOptions);
-  bus.emit("progress", "analyzing: add focus (if any)", {
-    level: busLogLevels.INFO,
-  });
+  bus.info("analyzing: add focus (if any)");
   lModules = addFocus(lModules, pOptions.focus);
 
   // when validate === false we might want to skip the addValidations.
   // We don't at this time, however, as "valid" is a mandatory
   // attribute (to simplify reporter logic)
-  bus.emit("progress", "analyzing: validations", { level: busLogLevels.INFO });
+  bus.info("analyzing: validations");
   lModules = addValidations(lModules, pOptions.ruleSet, pOptions.validate);
 
   lModules = softenKnownViolations(lModules, pOptions.knownViolations);

package/src/enrich/soften-known-violations.mjs

@@ -1,5 +1,4 @@
-import bus from "../utl/bus.mjs";
-import busLogLevels from "../utl/bus-log-levels.mjs";
+import { bus } from "../utl/bus.mjs";
 import isSameViolation from "./summarize/is-same-violation.mjs";
 
 function softenModuleViolation(
@@ -118,9 +117,7 @@ export default function softenKnownViolations(
   pSoftenedSeverity = "ignore"
 ) {
   if (Boolean(pKnownViolations)) {
-    bus.emit("progress", "analyzing: comparing against known errors", {
-      level: busLogLevels.INFO,
-    });
+    bus.info("analyzing: comparing against known errors");
     return pModules.map((pModule) =>
       softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity)
     );

package/src/extract/index.mjs

@@ -1,6 +1,5 @@
 import has from "lodash/has.js";
-import bus from "../utl/bus.mjs";
-import busLogLevels from "../utl/bus-log-levels.mjs";
+import { bus } from "../utl/bus.mjs";
 import getDependencies from "./get-dependencies.mjs";
 import gatherInitialSources from "./gather-initial-sources.mjs";
 import clearCaches from "./clear-caches.mjs";
@@ -62,17 +61,13 @@ function extractFileDirectoryArray(
 ) {
   let lVisited = new Set();
 
-  bus.emit("progress", "reading files: gathering initial sources", {
-    level: busLogLevels.INFO,
-  });
+  bus.info("reading files: gathering initial sources");
   const lInitialSources = gatherInitialSources(
     pFileDirectoryArray,
     pCruiseOptions
   );
 
-  bus.emit("progress", "reading files: visiting dependencies", {
-    level: busLogLevels.INFO,
-  });
+  bus.info("reading files: visiting dependencies");
   return lInitialSources.reduce((pDependencies, pFilename) => {
     if (!lVisited.has(pFilename)) {
       lVisited.add(pFilename);

package/src/extract/transpile/index.mjs

@@ -1,4 +1,77 @@
-import { getWrapper } from "./meta.mjs";
+/* eslint-disable import/exports-last */
+/* eslint security/detect-object-injection : 0*/
+import javaScriptWrap from "./javascript-wrap.mjs";
+import typeScriptWrap from "./typescript-wrap.mjs";
+import liveScriptWrap from "./livescript-wrap.mjs";
+import coffeeWrap from "./coffeescript-wrap.mjs";
+import vueWrap from "./vue-template-wrap.cjs";
+import babelWrap from "./babel-wrap.mjs";
+import svelteDingus from "./svelte-wrap.mjs";
+
+const typeScriptVanillaWrap = typeScriptWrap();
+const typeScriptESMWrap = typeScriptWrap("esm");
+const typeScriptTsxWrap = typeScriptWrap("tsx");
+const coffeeVanillaWrap = coffeeWrap();
+const litCoffeeWrap = coffeeWrap(true);
+const svelteWrap = svelteDingus(typeScriptVanillaWrap);
+
+export const EXTENSION2WRAPPER = {
+  ".js": javaScriptWrap,
+  ".cjs": javaScriptWrap,
+  ".mjs": javaScriptWrap,
+  ".jsx": javaScriptWrap,
+  ".ts": typeScriptVanillaWrap,
+  ".tsx": typeScriptTsxWrap,
+  ".d.ts": typeScriptVanillaWrap,
+  ".cts": typeScriptVanillaWrap,
+  ".d.cts": typeScriptVanillaWrap,
+  ".mts": typeScriptESMWrap,
+  ".d.mts": typeScriptESMWrap,
+  ".vue": vueWrap,
+  ".svelte": svelteWrap,
+  ".ls": liveScriptWrap,
+  ".coffee": coffeeVanillaWrap,
+  ".litcoffee": litCoffeeWrap,
+  ".coffee.md": litCoffeeWrap,
+  ".csx": coffeeVanillaWrap,
+  ".cjsx": coffeeVanillaWrap,
+};
+
+const BABELEABLE_EXTENSIONS = [
+  ".js",
+  ".cjs",
+  ".mjs",
+  ".jsx",
+  ".ts",
+  ".tsx",
+  ".d.ts",
+];
+
+/**
+ * returns the babel wrapper if there's a babelConfig in the transpiler
+ * options for babeleable extensions (javascript and typescript - currently
+ * not configurable)
+ *
+ * returns the wrapper module configured for the extension pExtension if
+ * not.
+ *
+ * returns the javascript wrapper if there's no wrapper module configured
+ * for the extension.
+ *
+ * @param {string}  pExtension the extension (e.g. ".ts", ".js", ".litcoffee")
+ * @param {any} pTranspilerOptions
+ * @returns {module} the module
+ */
+export function getWrapper(pExtension, pTranspilerOptions) {
+  if (
+    Object.keys(pTranspilerOptions?.babelConfig ?? {}).length > 0 &&
+    BABELEABLE_EXTENSIONS.includes(pExtension)
+  ) {
+    return babelWrap;
+  }
+
+  return EXTENSION2WRAPPER[pExtension] || javaScriptWrap;
+}
 
 /**
  * Transpiles the string pFile with the transpiler configured for extension

package/src/extract/transpile/meta.mjs

@@ -1,66 +1,58 @@
+/* eslint-disable import/exports-last */
 /* eslint security/detect-object-injection : 0*/
 import meta from "../../meta.js";
-import swc from "../parse/to-swc-ast.mjs";
-import javaScriptWrap from "./javascript-wrap.mjs";
-import typeScriptWrap from "./typescript-wrap.mjs";
-import liveScriptWrap from "./livescript-wrap.mjs";
-import coffeeWrap from "./coffeescript-wrap.mjs";
-import vueWrap from "./vue-template-wrap.cjs";
-import babelWrap from "./babel-wrap.mjs";
-import svelteDingus from "./svelte-wrap.mjs";
+import tryAvailable from "./try-import-available.mjs";
 
-const typeScriptVanillaWrap = typeScriptWrap();
-const typeScriptESMWrap = typeScriptWrap("esm");
-const typeScriptTsxWrap = typeScriptWrap("tsx");
-const coffeeVanillaWrap = coffeeWrap();
-const litCoffeeWrap = coffeeWrap(true);
-const svelteWrap = svelteDingus(typeScriptVanillaWrap);
+function gotCoffee() {
+  return (
+    tryAvailable("coffeescript", meta.supportedTranspilers.coffeescript) ||
+    tryAvailable("coffee-script", meta.supportedTranspilers["coffee-script"])
+  );
+}
 
-const EXTENSION2WRAPPER = {
-  ".js": javaScriptWrap,
-  ".cjs": javaScriptWrap,
-  ".mjs": javaScriptWrap,
-  ".jsx": javaScriptWrap,
-  ".ts": typeScriptVanillaWrap,
-  ".tsx": typeScriptTsxWrap,
-  ".d.ts": typeScriptVanillaWrap,
-  ".cts": typeScriptVanillaWrap,
-  ".d.cts": typeScriptVanillaWrap,
-  ".mts": typeScriptESMWrap,
-  ".d.mts": typeScriptESMWrap,
-  ".vue": vueWrap,
-  ".svelte": svelteWrap,
-  ".ls": liveScriptWrap,
-  ".coffee": coffeeVanillaWrap,
-  ".litcoffee": litCoffeeWrap,
-  ".coffee.md": litCoffeeWrap,
-  ".csx": coffeeVanillaWrap,
-  ".cjsx": coffeeVanillaWrap,
+const TRANSPILER2AVAILABLE = {
+  babel: tryAvailable("@babel/core", meta.supportedTranspilers.babel),
+  javascript: true,
+  "coffee-script": gotCoffee(),
+  coffeescript: gotCoffee(),
+  livescript: tryAvailable("livescript", meta.supportedTranspilers.livescript),
+  svelte: tryAvailable("svelte/compiler", meta.supportedTranspilers.svelte),
+  swc: tryAvailable("@swc/core", meta.supportedTranspilers.swc),
+  typescript: tryAvailable("typescript", meta.supportedTranspilers.typescript),
+  "vue-template-compiler": tryAvailable(
+    "vue-template-compiler",
+    meta.supportedTranspilers["vue-template-compiler"]
+  ),
+  "@vue/compiler-sfc": tryAvailable(
+    "@vue/compiler-sfc",
+    meta.supportedTranspilers["@vue/compiler-sfc"]
+  ),
 };
 
-const TRANSPILER2WRAPPER = {
-  babel: babelWrap,
-  javascript: javaScriptWrap,
-  "coffee-script": coffeeVanillaWrap,
-  coffeescript: coffeeVanillaWrap,
-  livescript: liveScriptWrap,
-  svelte: svelteWrap,
-  swc,
-  typescript: typeScriptVanillaWrap,
-  "vue-template-compiler": vueWrap,
-  "@vue/compiler-sfc": vueWrap,
+export const EXTENSION2AVAILABLE = {
+  ".js": TRANSPILER2AVAILABLE.javascript,
+  ".cjs": TRANSPILER2AVAILABLE.javascript,
+  ".mjs": TRANSPILER2AVAILABLE.javascript,
+  ".jsx": TRANSPILER2AVAILABLE.javascript,
+  ".ts": TRANSPILER2AVAILABLE.typescript,
+  ".tsx": TRANSPILER2AVAILABLE.typescript,
+  ".d.ts": TRANSPILER2AVAILABLE.typescript,
+  ".cts": TRANSPILER2AVAILABLE.typescript,
+  ".d.cts": TRANSPILER2AVAILABLE.typescript,
+  ".mts": TRANSPILER2AVAILABLE.typescript,
+  ".d.mts": TRANSPILER2AVAILABLE.typescript,
+  ".vue":
+    TRANSPILER2AVAILABLE["vue-template-compiler"] ||
+    TRANSPILER2AVAILABLE["@vue/compiler-sfc"],
+  ".svelte": TRANSPILER2AVAILABLE.svelte,
+  ".ls": TRANSPILER2AVAILABLE.livescript,
+  ".coffee": gotCoffee(),
+  ".litcoffee": gotCoffee(),
+  ".coffee.md": gotCoffee(),
+  ".csx": gotCoffee(),
+  ".cjsx": gotCoffee(),
 };
 
-const BABELEABLE_EXTENSIONS = [
-  ".js",
-  ".cjs",
-  ".mjs",
-  ".jsx",
-  ".ts",
-  ".tsx",
-  ".d.ts",
-];
-
 const EXTENSIONS_PER_PARSER = {
   swc: [".js", ".cjs", ".mjs", ".jsx", ".ts", ".tsx", ".d.ts"],
   // tsc: [".js", ".cjs", ".mjs", ".jsx", ".ts", ".tsx", ".d.ts"],
@@ -69,44 +61,19 @@ const EXTENSIONS_PER_PARSER = {
 
 function extensionIsAvailable(pExtension) {
   return (
-    EXTENSION2WRAPPER[pExtension].isAvailable() ||
+    EXTENSION2AVAILABLE[pExtension] ||
     // should eventually also check whether swc is enabled as a parser?
-    (swc.isAvailable() && EXTENSIONS_PER_PARSER.swc.includes(pExtension))
+    (TRANSPILER2AVAILABLE.swc && EXTENSIONS_PER_PARSER.swc.includes(pExtension))
   );
 }
 
-/**
- * returns the babel wrapper if there's a babelConfig in the transpiler
- * options for babeleable extensions (javascript and typescript - currently
- * not configurable)
- *
- * returns the wrapper module configured for the extension pExtension if
- * not.
- *
- * returns the javascript wrapper if there's no wrapper module configured
- * for the extension.
- *
- * @param {string}  pExtension the extension (e.g. ".ts", ".js", ".litcoffee")
- * @param {any} pTranspilerOptions
- * @returns {module} the module
- */
-export function getWrapper(pExtension, pTranspilerOptions) {
-  if (
-    Object.keys(pTranspilerOptions?.babelConfig ?? {}).length > 0 &&
-    BABELEABLE_EXTENSIONS.includes(pExtension)
-  ) {
-    return babelWrap;
-  }
-  return EXTENSION2WRAPPER[pExtension] || javaScriptWrap;
-}
-
 /**
  * all supported extensions and whether or not it is supported
  * in the current environment
  *
  * @type {IAvailableExtension[]}
  */
-export const allExtensions = Object.keys(EXTENSION2WRAPPER).map(
+export const allExtensions = Object.keys(EXTENSION2AVAILABLE).map(
   (pExtension) => ({
     extension: pExtension,
     available: extensionIsAvailable(pExtension),
@@ -120,7 +87,7 @@ export const allExtensions = Object.keys(EXTENSION2WRAPPER).map(
  * @type {string[]}
  */
 export const scannableExtensions =
-  Object.keys(EXTENSION2WRAPPER).filter(extensionIsAvailable);
+  Object.keys(EXTENSION2AVAILABLE).filter(extensionIsAvailable);
 
 /**
  * returns an array of supported transpilers, with for each transpiler:
@@ -133,6 +100,6 @@ export function getAvailableTranspilers() {
   return Object.keys(meta.supportedTranspilers).map((pTranspiler) => ({
     name: pTranspiler,
     version: meta.supportedTranspilers[pTranspiler],
-    available: TRANSPILER2WRAPPER[pTranspiler].isAvailable(),
+    available: TRANSPILER2AVAILABLE[pTranspiler],
   }));
 }

package/src/extract/transpile/try-import-available.mjs

@@ -0,0 +1,46 @@
+import path from "node:path/posix";
+import { createRequire } from "node:module";
+import { coerce, satisfies } from "semver";
+
+const require = createRequire(import.meta.url);
+
+const PACKAGE_RE = "[^/]+";
+const SCOPED_PACKAGE_RE = "@[^/]+(/[^/]+)";
+const ROOT_MODULE_RE = new RegExp(`^(${SCOPED_PACKAGE_RE}|${PACKAGE_RE})`, "g");
+
+function extractRootModuleName(pModuleName) {
+  return (pModuleName.match(ROOT_MODULE_RE) || []).shift();
+}
+
+function getVersion(pModuleName) {
+  // of course we'd love to use something like an import with an import assertion
+  // (yo, you're import-ing 'json'!), but that's _experimental_, printing scary
+  // messages to stderr so: ¯\_(ツ)_/¯
+  // eslint-disable-next-line import/no-dynamic-require, security/detect-non-literal-require
+  const lManifest = require(path.join(
+    extractRootModuleName(pModuleName),
+    "package.json"
+  ));
+  return lManifest.version;
+}
+
+export default function tryImportAvailable(pModuleName, pSemanticVersion) {
+  try {
+    if (pSemanticVersion) {
+      const lVersion = getVersion(pModuleName);
+      const lCoerced = coerce(lVersion);
+      if (
+        lVersion &&
+        lCoerced &&
+        !satisfies(lCoerced.version, pSemanticVersion)
+      ) {
+        return false;
+      }
+    }
+    // of course we'd love to use something like import.meta.resolve, but
+    // that's _experimental_, so ¯\_(ツ)_/¯
+    return Boolean(require.resolve(pModuleName));
+  } catch (pError) {
+    return false;
+  }
+}

package/src/main/cruise.mjs

@@ -1,7 +1,6 @@
 /* eslint-disable no-return-await */
 /* eslint-disable no-magic-numbers */
-
-import bus from "../utl/bus.mjs";
+import { bus } from "../utl/bus.mjs";
 import { validateCruiseOptions } from "./options/validate.mjs";
 import { normalizeCruiseOptions } from "./options/normalize.mjs";
 import reportWrap from "./report-wrap.mjs";
@@ -20,7 +19,7 @@ export default async function cruise(
   pResolveOptions,
   pTranspileOptions
 ) {
-  bus.emit("progress", "parsing options", c(1));
+  bus.summary("parsing options", c(1));
   /** @type {import("../../types/strict-options.js").IStrictCruiseOptions} */
   let lCruiseOptions = normalizeCruiseOptions(
     validateCruiseOptions(pCruiseOptions),
@@ -29,23 +28,22 @@ export default async function cruise(
   let lCache = null;
 
   if (lCruiseOptions.cache) {
-    bus.emit(
-      "progress",
-      `cache: check freshness with ${lCruiseOptions.cache.strategy}`,
+    bus.summary(
+      `cache: checking freshness with ${lCruiseOptions.cache.strategy}`,
       c(2)
     );
 
     const { default: Cache } = await import("../cache/cache.mjs");
     lCache = new Cache(lCruiseOptions.cache.strategy);
-    const lCachedResults = lCache.read(lCruiseOptions.cache.folder);
+    const lCachedResults = await lCache.read(lCruiseOptions.cache.folder);
 
-    if (lCache.canServeFromCache(lCruiseOptions, lCachedResults)) {
-      bus.emit("progress", "cache: reporting from cache", c(8));
+    if (await lCache.canServeFromCache(lCruiseOptions, lCachedResults)) {
+      bus.summary("cache: reporting from cache", c(8));
       return await reportWrap(lCachedResults, lCruiseOptions);
     }
   }
 
-  bus.emit("progress", "importing analytical modules", c(3));
+  bus.summary("importing analytical modules", c(3));
   const [
     { default: normalizeRuleSet },
     { default: validateRuleSet },
@@ -65,7 +63,7 @@ export default async function cruise(
   ]);
 
   if (Boolean(lCruiseOptions.ruleSet)) {
-    bus.emit("progress", "parsing rule set", c(4));
+    bus.summary("parsing rule set", c(4));
     lCruiseOptions.ruleSet = normalizeRuleSet(
       validateRuleSet(lCruiseOptions.ruleSet)
     );
@@ -75,14 +73,14 @@ export default async function cruise(
     pFileAndDirectoryArray
   );
 
-  bus.emit("progress", "determining how to resolve", c(5));
+  bus.summary("determining how to resolve", c(5));
   const lNormalizedResolveOptions = await normalizeResolveOptions(
     pResolveOptions,
     lCruiseOptions,
     pTranspileOptions?.tsConfig
   );
 
-  bus.emit("progress", "reading files", c(6));
+  bus.summary("reading files", c(6));
   const lExtractionResult = extract(
     lNormalizedFileAndDirectoryArray,
     lCruiseOptions,
@@ -90,7 +88,7 @@ export default async function cruise(
     pTranspileOptions
   );
 
-  bus.emit("progress", "analyzing", c(7));
+  bus.summary("analyzing", c(7));
   const lCruiseResult = enrich(
     lExtractionResult,
     lCruiseOptions,
@@ -98,10 +96,10 @@ export default async function cruise(
   );
 
   if (lCruiseOptions.cache) {
-    bus.emit("progress", "cache: save", c(8));
-    lCache.write(lCruiseOptions.cache.folder, lCruiseResult);
+    bus.summary("cache: saving", c(8));
+    await lCache.write(lCruiseOptions.cache.folder, lCruiseResult);
   }
 
-  bus.emit("progress", "reporting", c(9));
+  bus.summary("reporting", c(9));
   return await reportWrap(lCruiseResult, lCruiseOptions);
 }

package/src/meta.js

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

package/src/schema/cruise-result.schema.mjs

@@ -1 +1 @@
-/* generated - don't edit */export default {"title":"dependency-cruiser output format","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dependency-cruiser.js.org/schema/cruise-result.schema.json","type":"object","required":["summary","modules"],"additionalProperties":false,"properties":{"modules":{"$ref":"#/definitions/ModulesType"},"folders":{"$ref":"#/definitions/FoldersType"},"summary":{"$ref":"#/definitions/SummaryType"},"revisionData":{"$ref":"#/definitions/RevisionDataType"}},"definitions":{"ModulesType":{"type":"array","items":{"$ref":"#/definitions/ModuleType"}},"ModuleType":{"type":"object","required":["source","dependencies","valid"],"additionalProperties":false,"properties":{"source":{"type":"string"},"valid":{"type":"boolean"},"dependencies":{"$ref":"#/definitions/DependenciesType"},"dependents":{"type":"array","items":{"type":"string"}},"followable":{"type":"boolean"},"matchesDoNotFollow":{"type":"boolean"},"matchesFocus":{"type":"boolean"},"matchesReaches":{"type":"boolean"},"matchesHighlight":{"type":"boolean"},"coreModule":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"orphan":{"type":"boolean"},"reachable":{"type":"array","items":{"$ref":"#/definitions/ReachableType"}},"reaches":{"type":"array","items":{"$ref":"#/definitions/ReachesType"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"consolidated":{"type":"boolean"},"instability":{"type":"number"}}},"ReachableType":{"type":"object","required":["value","asDefinedInRule","matchedFrom"],"additionalProperties":false,"properties":{"value":{"type":"boolean"},"asDefinedInRule":{"type":"string"},"matchedFrom":{"type":"string"}}},"ReachesType":{"type":"object","required":["modules","asDefinedInRule"],"additionalProperties":false,"properties":{"modules":{"type":"array","items":{"type":"object","required":["source","via"],"additionalProperties":false,"properties":{"source":{"type":"string"},"via":{"type":"array","items":{"type":"string"}}}}},"asDefinedInRule":{"type":"string"}}},"DependenciesType":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"DependencyType":{"type":"object","required":["circular","coreModule","couldNotResolve","dependencyTypes","exoticallyRequired","dynamic","followable","module","moduleSystem","resolved","valid"],"additionalProperties":false,"properties":{"module":{"type":"string"},"protocol":{"type":"string","enum":["data:","file:","node:"]},"mimeType":{"type":"string"},"resolved":{"type":"string"},"coreModule":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"followable":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"type":"string"},"matchesDoNotFollow":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"preCompilationOnly":{"type":"boolean"},"typeOnly":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"moduleSystem":{"$ref":"#/definitions/ModuleSystemType"},"valid":{"type":"boolean"},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"instability":{"type":"number"}}},"DependencyTypeType":{"type":"string","enum":["aliased","core","deprecated","local","localmodule","npm","npm-bundled","npm-dev","npm-no-pkg","npm-optional","npm-peer","npm-unknown","undetermined","unknown","type-only"]},"ModuleSystemType":{"type":"string","enum":["cjs","es6","amd","tsd"]},"RuleSummaryType":{"type":"object","required":["name","severity"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"}}},"SeverityType":{"type":"string","enum":["error","warn","info","ignore"]},"FoldersType":{"type":"array","items":{"$ref":"#/definitions/FolderType"}},"FolderType":{"type":"object","required":["name","moduleCount"],"additionalProperties":false,"properties":{"name":{"type":"string"},"dependents":{"type":"array","items":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string"}}}},"dependencies":{"type":"array","items":{"type":"object","required":["name","valid","circular"],"additionalProperties":false,"properties":{"name":{"type":"string"},"instability":{"type":"number"},"valid":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}}}}},"moduleCount":{"type":"number"},"afferentCouplings":{"type":"number"},"efferentCouplings":{"type":"number"},"instability":{"type":"number"}}},"SummaryType":{"type":"object","required":["violations","error","warn","info","totalCruised","optionsUsed"],"additionalProperties":false,"properties":{"violations":{"$ref":"#/definitions/ViolationsType"},"error":{"type":"number"},"warn":{"type":"number"},"info":{"type":"number"},"ignore":{"type":"number"},"totalCruised":{"type":"number"},"totalDependenciesCruised":{"type":"number"},"ruleSetUsed":{"$ref":"#/definitions/RuleSetType"},"optionsUsed":{"$ref":"#/definitions/OptionsUsedType"}}},"ViolationsType":{"type":"array","items":{"$ref":"#/definitions/ViolationType"}},"ViolationType":{"type":"object","required":["from","to","rule"],"additionalProperties":false,"properties":{"from":{"type":"string"},"to":{"type":"string"},"type":{"$ref":"#/definitions/ViolationTypeType"},"rule":{"$ref":"#/definitions/RuleSummaryType"},"cycle":{"type":"array","items":{"type":"string"}},"via":{"type":"array","items":{"type":"string"}},"metrics":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"from":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}},"to":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}}}},"comment":{"type":"string"}}},"ViolationTypeType":{"type":"string","enum":["dependency","module","reachability","cycle","instability","folder"]},"RuleSetType":{"type":"object","additionalProperties":false,"properties":{"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}}}},"AllowedRuleType":{"oneOf":[{"$ref":"#/definitions/RegularAllowedRuleType"},{"$ref":"#/definitions/ReachabilityAllowedRuleType"}]},"RegularAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"ReachabilityAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"ForbiddenRuleType":{"oneOf":[{"$ref":"#/definitions/RegularForbiddenRuleType"},{"$ref":"#/definitions/ReachabilityForbiddenRuleType"},{"$ref":"#/definitions/DependentsForbiddenRuleType"}]},"RegularForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"DependentsForbiddenRuleType":{"type":"object","required":["module","from"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/DependentsModuleRestrictionType"},"from":{"$ref":"#/definitions/DependentsFromRestrictionType"}}},"ReachabilityForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"RequiredRuleType":{"type":"object","required":["module","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/RequiredModuleRestrictionType"},"to":{"$ref":"#/definitions/RequiredToRestrictionType"}}},"FromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"orphan":{"type":"boolean"}}},"ReachabilityFromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ToRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"couldNotResolve":{"type":"boolean"},"circular":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"$ref":"#/definitions/REAsStringsType"},"exoticRequireNot":{"$ref":"#/definitions/REAsStringsType"},"preCompilationOnly":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"moreThanOneDependencyType":{"type":"boolean"},"license":{"$ref":"#/definitions/REAsStringsType"},"licenseNot":{"$ref":"#/definitions/REAsStringsType"},"via":{"$ref":"#/definitions/REAsStringsType"},"viaOnly":{"$ref":"#/definitions/REAsStringsType"},"viaNot":{"$ref":"#/definitions/REAsStringsType"},"viaSomeNot":{"$ref":"#/definitions/REAsStringsType"},"moreUnstable":{"type":"boolean"}}},"DependentsModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"numberOfDependentsLessThan":{"type":"integer","minimum":0,"maximum":100},"numberOfDependentsMoreThan":{"type":"integer","minimum":0,"maximum":100}}},"DependentsFromRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ReachabilityToRestrictionType":{"required":["reachable"],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean"}}},"RequiredModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"RequiredToRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"REAsStringsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"OptionsUsedType":{"type":"object","additionalProperties":false,"properties":{"doNotFollow":{"$ref":"#/definitions/CompoundDoNotFollowType"},"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundIncludeOnlyType"}]},"focus":{"$ref":"#/definitions/CompoundFocusType"},"reaches":{"$ref":"#/definitions/CompoundReachesType"},"highlight":{"$ref":"#/definitions/CompoundHighlightType"},"knownViolations":{"$ref":"#/definitions/ViolationsType"},"collapse":{"type":"string"},"maxDepth":{"type":"integer","minimum":0,"maximum":99},"moduleSystems":{"$ref":"#/definitions/ModuleSystemsType"},"prefix":{"type":"string"},"preserveSymlinks":{"type":"boolean"},"combinedDependencies":{"type":"boolean"},"tsConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"tsPreCompilationDeps":{"oneOf":[{"type":"boolean"},{"type":"string","enum":["specify"]}]},"extraExtensionsToScan":{"type":"array","items":{"type":"string"}},"externalModuleResolutionStrategy":{"type":"string","enum":["node_modules","yarn-pnp"]},"forceDeriveDependents":{"type":"boolean"},"webpackConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"},"env":{"oneOf":[{"type":"object"},{"type":"string"}]},"arguments":{"type":"object"}}},"enhancedResolveOptions":{"type":"object","additionalProperties":false,"properties":{"exportsFields":{"type":"array","items":{"type":"string"}},"conditionNames":{"type":"array","items":{"type":"string"}},"extensions":{"type":"array","items":{"type":"string"}},"mainFields":{"type":"array"},"mainFiles":{"type":"array"},"cachedInputFileSystem":{"type":"object","additionalProperties":false,"properties":{"cacheDuration":{"type":"integer","minimum":0,"maximum":1800000}}}}},"babelConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"parser":{"type":"string","enum":["acorn","swc","tsc"]},"exoticRequireStrings":{"type":"array","items":{"type":"string"}},"reporterOptions":{"$ref":"#/definitions/ReporterOptionsType"},"progress":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["cli-feedback","performance-log","ndjson","none"]},"maximumLevel":{"type":"number","enum":[-1,40,50,60,70,80,99]}}},"metrics":{"type":"boolean"},"baseDir":{"type":"string"},"cache":{"oneOf":[{"type":"boolean","enum":[false]},{"$ref":"#/definitions/CacheOptionsType"}]},"args":{"type":"string"},"rulesFile":{"type":"string"},"outputTo":{"type":"string"},"outputType":{"$ref":"#/definitions/OutputType"}}},"ModuleSystemsType":{"type":"array","items":{"$ref":"#/definitions/ModuleSystemType"}},"OutputType":{"oneOf":[{"type":"string","enum":["json","html","dot","ddot","cdot","archi","fdot","flat","csv","err","err-long","err-html","teamcity","anon","text","metrics","markdown","mermaid"]},{"type":"string","pattern":"^plugin:[^:]+$"}]},"CompoundExcludeType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dynamic":{"type":"boolean"}}},"CompoundDoNotFollowType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}}}},"CompoundIncludeOnlyType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundFocusType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"depth":{"type":"number","minimum":1,"maximum":4}}},"CompoundReachesType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundHighlightType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"ReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"anon":{"$ref":"#/definitions/AnonReporterOptionsType"},"archi":{"$ref":"#/definitions/DotReporterOptionsType"},"dot":{"$ref":"#/definitions/DotReporterOptionsType"},"ddot":{"$ref":"#/definitions/DotReporterOptionsType"},"flat":{"$ref":"#/definitions/DotReporterOptionsType"},"markdown":{"$ref":"#/definitions/MarkdownReporterOptionsType"},"metrics":{"$ref":"#/definitions/MetricsReporterOptionsType"},"mermaid":{"$ref":"#/definitions/MermaidReporterOptionsType"},"text":{"$ref":"#/definitions/TextReporterOptionsType"}}},"AnonReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"wordlist":{"type":"array","items":{"type":"string"}}}},"MetricsReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"orderBy":{"type":"string","enum":["instability","moduleCount","afferentCouplings","efferentCouplings","name"]},"hideModules":{"type":"boolean"},"hideFolders":{"type":"boolean"}}},"MarkdownReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"showTitle":{"type":"boolean"},"title":{"type":"string"},"showSummary":{"type":"boolean"},"showSummaryHeader":{"type":"boolean"},"summaryHeader":{"type":"string"},"showStatsSummary":{"type":"boolean"},"showRulesSummary":{"type":"boolean"},"includeIgnoredInSummary":{"type":"boolean"},"showDetails":{"type":"boolean"},"includeIgnoredInDetails":{"type":"boolean"},"showDetailsHeader":{"type":"boolean"},"detailsHeader":{"type":"string"},"collapseDetails":{"type":"boolean"},"collapsedMessage":{"type":"string"},"noViolationsMessage":{"type":"string"},"showFooter":{"type":"boolean"}}},"MermaidReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"boolean"}}},"TextReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"highlightFocused":{"type":"boolean"}}},"DotReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"collapsePattern":{"$ref":"#/definitions/REAsStringsType"},"filters":{"$ref":"#/definitions/ReporterFiltersType"},"showMetrics":{"type":"boolean"},"theme":{"$ref":"#/definitions/DotThemeType"}}},"DotThemeType":{"type":"object","additionalProperties":false,"properties":{"replace":{"type":"boolean"},"graph":{"type":"object"},"node":{"type":"object"},"edge":{"type":"object"},"modules":{"$ref":"#/definitions/DotThemeArrayType"},"dependencies":{"$ref":"#/definitions/DotThemeArrayType"}}},"DotThemeArrayType":{"type":"array","items":{"$ref":"#/definitions/DotThemeEntryType"}},"DotThemeEntryType":{"type":"object","additionalProperties":false,"properties":{"criteria":{"type":"object"},"attributes":{"type":"object"}}},"ReporterFiltersType":{"type":"object","additionalProperties":false,"properties":{"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"$ref":"#/definitions/CompoundIncludeOnlyType"},"focus":{"$ref":"#/definitions/CompoundFocusType"},"reaches":{"$ref":"#/definitions/CompoundReachesType"}}},"CacheOptionsType":{"type":"object","additionalProperties":false,"properties":{"folder":{"type":"string"},"strategy":{"$ref":"#/definitions/CacheStrategyType"}}},"CacheStrategyType":{"type":"string","enum":["metadata","content"]},"RevisionDataType":{"type":"object","required":["SHA1","changes"],"properties":{"SHA1":{"type":"string"},"changes":{"type":"array","items":{"type":"object","required":["name","changeType"],"properties":{"name":{"type":"string"},"changeType":{"type":"string","enum":["added","copied","deleted","modified","renamed","type changed","unmerged","pairing broken","unknown","unmodified","untracked","ignored"]},"oldName":{"type":"string"},"checksum":{"type":"string"},"args":{"type":"array","items":{"type":"string"}},"rulesFile":{"type":"string"}}}}}}}}
+/* generated - don't edit */export default {"title":"dependency-cruiser output format","$schema":"http://json-schema.org/draft-07/schema#","$id":"https://dependency-cruiser.js.org/schema/cruise-result.schema.json","type":"object","required":["summary","modules"],"additionalProperties":false,"properties":{"modules":{"$ref":"#/definitions/ModulesType"},"folders":{"$ref":"#/definitions/FoldersType"},"summary":{"$ref":"#/definitions/SummaryType"},"revisionData":{"$ref":"#/definitions/RevisionDataType"}},"definitions":{"ModulesType":{"type":"array","items":{"$ref":"#/definitions/ModuleType"}},"ModuleType":{"type":"object","required":["source","dependencies","valid"],"additionalProperties":false,"properties":{"source":{"type":"string"},"valid":{"type":"boolean"},"dependencies":{"$ref":"#/definitions/DependenciesType"},"dependents":{"type":"array","items":{"type":"string"}},"followable":{"type":"boolean"},"matchesDoNotFollow":{"type":"boolean"},"matchesFocus":{"type":"boolean"},"matchesReaches":{"type":"boolean"},"matchesHighlight":{"type":"boolean"},"coreModule":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"orphan":{"type":"boolean"},"reachable":{"type":"array","items":{"$ref":"#/definitions/ReachableType"}},"reaches":{"type":"array","items":{"$ref":"#/definitions/ReachesType"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"consolidated":{"type":"boolean"},"instability":{"type":"number"},"checksum":{"type":"string"}}},"ReachableType":{"type":"object","required":["value","asDefinedInRule","matchedFrom"],"additionalProperties":false,"properties":{"value":{"type":"boolean"},"asDefinedInRule":{"type":"string"},"matchedFrom":{"type":"string"}}},"ReachesType":{"type":"object","required":["modules","asDefinedInRule"],"additionalProperties":false,"properties":{"modules":{"type":"array","items":{"type":"object","required":["source","via"],"additionalProperties":false,"properties":{"source":{"type":"string"},"via":{"type":"array","items":{"type":"string"}}}}},"asDefinedInRule":{"type":"string"}}},"DependenciesType":{"type":"array","items":{"$ref":"#/definitions/DependencyType"}},"DependencyType":{"type":"object","required":["circular","coreModule","couldNotResolve","dependencyTypes","exoticallyRequired","dynamic","followable","module","moduleSystem","resolved","valid"],"additionalProperties":false,"properties":{"module":{"type":"string"},"protocol":{"type":"string","enum":["data:","file:","node:"]},"mimeType":{"type":"string"},"resolved":{"type":"string"},"coreModule":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"license":{"type":"string"},"followable":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"type":"string"},"matchesDoNotFollow":{"type":"boolean"},"couldNotResolve":{"type":"boolean"},"preCompilationOnly":{"type":"boolean"},"typeOnly":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"moduleSystem":{"$ref":"#/definitions/ModuleSystemType"},"valid":{"type":"boolean"},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}},"instability":{"type":"number"}}},"DependencyTypeType":{"type":"string","enum":["aliased","core","deprecated","local","localmodule","npm","npm-bundled","npm-dev","npm-no-pkg","npm-optional","npm-peer","npm-unknown","undetermined","unknown","type-only"]},"ModuleSystemType":{"type":"string","enum":["cjs","es6","amd","tsd"]},"RuleSummaryType":{"type":"object","required":["name","severity"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"}}},"SeverityType":{"type":"string","enum":["error","warn","info","ignore"]},"FoldersType":{"type":"array","items":{"$ref":"#/definitions/FolderType"}},"FolderType":{"type":"object","required":["name","moduleCount"],"additionalProperties":false,"properties":{"name":{"type":"string"},"dependents":{"type":"array","items":{"type":"object","required":["name"],"additionalProperties":false,"properties":{"name":{"type":"string"}}}},"dependencies":{"type":"array","items":{"type":"object","required":["name","valid","circular"],"additionalProperties":false,"properties":{"name":{"type":"string"},"instability":{"type":"number"},"valid":{"type":"boolean"},"circular":{"type":"boolean"},"cycle":{"type":"array","items":{"type":"string"}},"rules":{"type":"array","items":{"$ref":"#/definitions/RuleSummaryType"}}}}},"moduleCount":{"type":"number"},"afferentCouplings":{"type":"number"},"efferentCouplings":{"type":"number"},"instability":{"type":"number"}}},"SummaryType":{"type":"object","required":["violations","error","warn","info","totalCruised","optionsUsed"],"additionalProperties":false,"properties":{"violations":{"$ref":"#/definitions/ViolationsType"},"error":{"type":"number"},"warn":{"type":"number"},"info":{"type":"number"},"ignore":{"type":"number"},"totalCruised":{"type":"number"},"totalDependenciesCruised":{"type":"number"},"ruleSetUsed":{"$ref":"#/definitions/RuleSetType"},"optionsUsed":{"$ref":"#/definitions/OptionsUsedType"}}},"ViolationsType":{"type":"array","items":{"$ref":"#/definitions/ViolationType"}},"ViolationType":{"type":"object","required":["from","to","rule"],"additionalProperties":false,"properties":{"from":{"type":"string"},"to":{"type":"string"},"type":{"$ref":"#/definitions/ViolationTypeType"},"rule":{"$ref":"#/definitions/RuleSummaryType"},"cycle":{"type":"array","items":{"type":"string"}},"via":{"type":"array","items":{"type":"string"}},"metrics":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"from":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}},"to":{"type":"object","required":["instability"],"additionalProperties":false,"properties":{"instability":{"type":"number"}}}}},"comment":{"type":"string"}}},"ViolationTypeType":{"type":"string","enum":["dependency","module","reachability","cycle","instability","folder"]},"RuleSetType":{"type":"object","additionalProperties":false,"properties":{"forbidden":{"type":"array","items":{"$ref":"#/definitions/ForbiddenRuleType"}},"allowed":{"type":"array","items":{"$ref":"#/definitions/AllowedRuleType"}},"allowedSeverity":{"$ref":"#/definitions/SeverityType"},"required":{"type":"array","items":{"$ref":"#/definitions/RequiredRuleType"}}}},"AllowedRuleType":{"oneOf":[{"$ref":"#/definitions/RegularAllowedRuleType"},{"$ref":"#/definitions/ReachabilityAllowedRuleType"}]},"RegularAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"ReachabilityAllowedRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"comment":{"type":"string"},"scope":{"type":"string","enum":["module","folder"]},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"ForbiddenRuleType":{"oneOf":[{"$ref":"#/definitions/RegularForbiddenRuleType"},{"$ref":"#/definitions/ReachabilityForbiddenRuleType"},{"$ref":"#/definitions/DependentsForbiddenRuleType"}]},"RegularForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/FromRestrictionType"},"to":{"$ref":"#/definitions/ToRestrictionType"}}},"DependentsForbiddenRuleType":{"type":"object","required":["module","from"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/DependentsModuleRestrictionType"},"from":{"$ref":"#/definitions/DependentsFromRestrictionType"}}},"ReachabilityForbiddenRuleType":{"type":"object","required":["from","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"from":{"$ref":"#/definitions/ReachabilityFromRestrictionType"},"to":{"$ref":"#/definitions/ReachabilityToRestrictionType"}}},"RequiredRuleType":{"type":"object","required":["module","to"],"additionalProperties":false,"properties":{"name":{"type":"string"},"severity":{"$ref":"#/definitions/SeverityType"},"scope":{"type":"string","enum":["module","folder"]},"comment":{"type":"string"},"module":{"$ref":"#/definitions/RequiredModuleRestrictionType"},"to":{"$ref":"#/definitions/RequiredToRestrictionType"}}},"FromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"orphan":{"type":"boolean"}}},"ReachabilityFromRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ToRestrictionType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"couldNotResolve":{"type":"boolean"},"circular":{"type":"boolean"},"dynamic":{"type":"boolean"},"exoticallyRequired":{"type":"boolean"},"exoticRequire":{"$ref":"#/definitions/REAsStringsType"},"exoticRequireNot":{"$ref":"#/definitions/REAsStringsType"},"preCompilationOnly":{"type":"boolean"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"dependencyTypesNot":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}},"moreThanOneDependencyType":{"type":"boolean"},"license":{"$ref":"#/definitions/REAsStringsType"},"licenseNot":{"$ref":"#/definitions/REAsStringsType"},"via":{"$ref":"#/definitions/REAsStringsType"},"viaOnly":{"$ref":"#/definitions/REAsStringsType"},"viaNot":{"$ref":"#/definitions/REAsStringsType"},"viaSomeNot":{"$ref":"#/definitions/REAsStringsType"},"moreUnstable":{"type":"boolean"}}},"DependentsModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"numberOfDependentsLessThan":{"type":"integer","minimum":0,"maximum":100},"numberOfDependentsMoreThan":{"type":"integer","minimum":0,"maximum":100}}},"DependentsFromRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"ReachabilityToRestrictionType":{"required":["reachable"],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"},"reachable":{"type":"boolean"}}},"RequiredModuleRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"pathNot":{"$ref":"#/definitions/REAsStringsType"}}},"RequiredToRestrictionType":{"required":[],"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"REAsStringsType":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"OptionsUsedType":{"type":"object","additionalProperties":false,"properties":{"doNotFollow":{"$ref":"#/definitions/CompoundDoNotFollowType"},"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"oneOf":[{"$ref":"#/definitions/REAsStringsType"},{"$ref":"#/definitions/CompoundIncludeOnlyType"}]},"focus":{"$ref":"#/definitions/CompoundFocusType"},"reaches":{"$ref":"#/definitions/CompoundReachesType"},"highlight":{"$ref":"#/definitions/CompoundHighlightType"},"knownViolations":{"$ref":"#/definitions/ViolationsType"},"collapse":{"type":"string"},"maxDepth":{"type":"integer","minimum":0,"maximum":99},"moduleSystems":{"$ref":"#/definitions/ModuleSystemsType"},"prefix":{"type":"string"},"preserveSymlinks":{"type":"boolean"},"combinedDependencies":{"type":"boolean"},"tsConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"tsPreCompilationDeps":{"oneOf":[{"type":"boolean"},{"type":"string","enum":["specify"]}]},"extraExtensionsToScan":{"type":"array","items":{"type":"string"}},"externalModuleResolutionStrategy":{"type":"string","enum":["node_modules","yarn-pnp"]},"forceDeriveDependents":{"type":"boolean"},"webpackConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"},"env":{"oneOf":[{"type":"object"},{"type":"string"}]},"arguments":{"type":"object"}}},"enhancedResolveOptions":{"type":"object","additionalProperties":false,"properties":{"exportsFields":{"type":"array","items":{"type":"string"}},"conditionNames":{"type":"array","items":{"type":"string"}},"extensions":{"type":"array","items":{"type":"string"}},"mainFields":{"type":"array"},"mainFiles":{"type":"array"},"cachedInputFileSystem":{"type":"object","additionalProperties":false,"properties":{"cacheDuration":{"type":"integer","minimum":0,"maximum":1800000}}}}},"babelConfig":{"type":"object","additionalProperties":false,"properties":{"fileName":{"type":"string"}}},"parser":{"type":"string","enum":["acorn","swc","tsc"]},"exoticRequireStrings":{"type":"array","items":{"type":"string"}},"reporterOptions":{"$ref":"#/definitions/ReporterOptionsType"},"progress":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["cli-feedback","performance-log","ndjson","none"]},"maximumLevel":{"type":"number","enum":[-1,40,50,60,70,80,99]}}},"metrics":{"type":"boolean"},"baseDir":{"type":"string"},"cache":{"oneOf":[{"type":"boolean","enum":[false]},{"$ref":"#/definitions/CacheOptionsType"}]},"args":{"type":"string"},"rulesFile":{"type":"string"},"outputTo":{"type":"string"},"outputType":{"$ref":"#/definitions/OutputType"}}},"ModuleSystemsType":{"type":"array","items":{"$ref":"#/definitions/ModuleSystemType"}},"OutputType":{"oneOf":[{"type":"string","enum":["json","html","dot","ddot","cdot","archi","fdot","flat","csv","err","err-long","err-html","teamcity","anon","text","metrics","markdown","mermaid","null"]},{"type":"string","pattern":"^plugin:[^:]+$"}]},"CompoundExcludeType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dynamic":{"type":"boolean"}}},"CompoundDoNotFollowType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"dependencyTypes":{"type":"array","items":{"$ref":"#/definitions/DependencyTypeType"}}}},"CompoundIncludeOnlyType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundFocusType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"},"depth":{"type":"number","minimum":1,"maximum":4}}},"CompoundReachesType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"CompoundHighlightType":{"type":"object","additionalProperties":false,"properties":{"path":{"$ref":"#/definitions/REAsStringsType"}}},"ReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"anon":{"$ref":"#/definitions/AnonReporterOptionsType"},"archi":{"$ref":"#/definitions/DotReporterOptionsType"},"dot":{"$ref":"#/definitions/DotReporterOptionsType"},"ddot":{"$ref":"#/definitions/DotReporterOptionsType"},"flat":{"$ref":"#/definitions/DotReporterOptionsType"},"markdown":{"$ref":"#/definitions/MarkdownReporterOptionsType"},"metrics":{"$ref":"#/definitions/MetricsReporterOptionsType"},"mermaid":{"$ref":"#/definitions/MermaidReporterOptionsType"},"text":{"$ref":"#/definitions/TextReporterOptionsType"}}},"AnonReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"wordlist":{"type":"array","items":{"type":"string"}}}},"MetricsReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"orderBy":{"type":"string","enum":["instability","moduleCount","afferentCouplings","efferentCouplings","name"]},"hideModules":{"type":"boolean"},"hideFolders":{"type":"boolean"}}},"MarkdownReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"showTitle":{"type":"boolean"},"title":{"type":"string"},"showSummary":{"type":"boolean"},"showSummaryHeader":{"type":"boolean"},"summaryHeader":{"type":"string"},"showStatsSummary":{"type":"boolean"},"showRulesSummary":{"type":"boolean"},"includeIgnoredInSummary":{"type":"boolean"},"showDetails":{"type":"boolean"},"includeIgnoredInDetails":{"type":"boolean"},"showDetailsHeader":{"type":"boolean"},"detailsHeader":{"type":"string"},"collapseDetails":{"type":"boolean"},"collapsedMessage":{"type":"string"},"noViolationsMessage":{"type":"string"},"showFooter":{"type":"boolean"}}},"MermaidReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"minify":{"type":"boolean"}}},"TextReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"highlightFocused":{"type":"boolean"}}},"DotReporterOptionsType":{"type":"object","additionalProperties":false,"properties":{"collapsePattern":{"$ref":"#/definitions/REAsStringsType"},"filters":{"$ref":"#/definitions/ReporterFiltersType"},"showMetrics":{"type":"boolean"},"theme":{"$ref":"#/definitions/DotThemeType"}}},"DotThemeType":{"type":"object","additionalProperties":false,"properties":{"replace":{"type":"boolean"},"graph":{"type":"object"},"node":{"type":"object"},"edge":{"type":"object"},"modules":{"$ref":"#/definitions/DotThemeArrayType"},"dependencies":{"$ref":"#/definitions/DotThemeArrayType"}}},"DotThemeArrayType":{"type":"array","items":{"$ref":"#/definitions/DotThemeEntryType"}},"DotThemeEntryType":{"type":"object","additionalProperties":false,"properties":{"criteria":{"type":"object"},"attributes":{"type":"object"}}},"ReporterFiltersType":{"type":"object","additionalProperties":false,"properties":{"exclude":{"$ref":"#/definitions/CompoundExcludeType"},"includeOnly":{"$ref":"#/definitions/CompoundIncludeOnlyType"},"focus":{"$ref":"#/definitions/CompoundFocusType"},"reaches":{"$ref":"#/definitions/CompoundReachesType"}}},"CacheOptionsType":{"type":"object","additionalProperties":false,"properties":{"folder":{"type":"string"},"strategy":{"$ref":"#/definitions/CacheStrategyType"}}},"CacheStrategyType":{"type":"string","enum":["metadata","content"]},"RevisionDataType":{"type":"object","required":["SHA1","changes"],"properties":{"SHA1":{"type":"string"},"changes":{"type":"array","items":{"type":"object","required":["name","changeType"],"properties":{"name":{"type":"string"},"changeType":{"type":"string","enum":["added","copied","deleted","modified","renamed","type changed","unmerged","pairing broken","unknown","unmodified","untracked","ignored"]},"oldName":{"type":"string"},"checksum":{"type":"string"},"args":{"type":"array","items":{"type":"string"}},"rulesFile":{"type":"string"}}}}}}}}

package/src/utl/bus.mjs

@@ -1,5 +1,30 @@
+/* eslint-disable import/exports-last */
 import EventEmitter from "node:events";
 
-const gBus = new EventEmitter();
+export const OFF = -1;
+export const SUMMARY = 40;
+export const INFO = 50;
+export const DEBUG = 60;
+export const TRACE = 70;
+export const EXTRA_STRONG = 80;
+export const ALL = 99;
 
-export default gBus;
+class Bus extends EventEmitter {
+  progress(pMessage, pOptions, ...pArguments) {
+    this.emit("progress", pMessage, pOptions, pArguments);
+  }
+
+  summary(pMessage, pOptions, ...pArguments) {
+    this.progress(pMessage, { ...pOptions, level: SUMMARY }, pArguments);
+  }
+
+  info(pMessage, pOptions, ...pArguments) {
+    this.progress(pMessage, { ...pOptions, level: INFO }, pArguments);
+  }
+
+  debug(pMessage, pOptions, ...pArguments) {
+    this.progress(pMessage, { ...pOptions, level: DEBUG }, pArguments);
+  }
+}
+
+export const bus = new Bus();

package/types/cruise-result.d.ts

@@ -139,6 +139,12 @@ export interface IModule {
    * was asked to calculate metrics.
    */
   instability?: number;
+  /**
+   * checksum of the contents of the module. This attribute is currently only
+   * available when the cruise was executed with caching and the cache strategy
+   * is 'content'.
+   */
+  checksum?: string;
 }
 
 export interface IDependency {

package/types/shared-types.d.ts

@@ -21,6 +21,7 @@ export type OutputType =
   | "metrics"
   | "markdown"
   | "mermaid"
+  | "null"
   // for plugins: string. TODO: research whether it's possible to
   // tie this down to the `^plugin:[^:]+-reporter-plugin.c?js$` regex
   | string;

package/src/utl/bus-log-levels.mjs

@@ -1,9 +0,0 @@
-export default {
-  OFF: -1,
-  SUMMARY: 40,
-  INFO: 50,
-  DEBUG: 60,
-  TRACE: 70,
-  EXTRA_STRONG: 80,
-  ALL: 99,
-};