dependency-cruiser 13.0.0-beta-5 → 13.0.0-beta-6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "13.0.0-beta-5",
+  "version": "13.0.0-beta-6",
   "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: "starting nodejs",
     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: "starting nodejs",
     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/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-6",
   engines: {
     node: "^16.14||>=18",
   },

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/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,
-};