dependency-cruiser 16.9.0 → 16.10.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "16.9.0",
+  "version": "16.10.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -145,9 +145,9 @@
     "acorn-loose": "^8.4.0",
     "acorn-walk": "^8.3.4",
     "ajv": "^8.17.1",
-    "commander": "^13.0.0",
-    "enhanced-resolve": "^5.18.0",
-    "ignore": "^7.0.0",
+    "commander": "^13.1.0",
+    "enhanced-resolve": "^5.18.1",
+    "ignore": "^7.0.3",
     "interpret": "^3.1.1",
     "is-installed-globally": "^1.0.0",
     "json5": "^2.2.3",
@@ -157,10 +157,10 @@
     "prompts": "^2.4.2",
     "rechoir": "^0.8.0",
     "safe-regex": "^2.1.1",
-    "semver": "^7.6.3",
+    "semver": "^7.7.1",
     "teamcity-service-messages": "^0.1.14",
     "tsconfig-paths-webpack-plugin": "^4.2.0",
-    "watskeburt": "^4.2.2"
+    "watskeburt": "^4.2.3"
   },
   "overrides": {
     "cross-spawn": ">=6.0.6"

package/src/cache/cache.mjs

@@ -87,7 +87,7 @@ export default class Cache {
         },
       ));
     this.#revisionData.cacheFormatVersion = CACHE_FORMAT_VERSION;
-    bus.debug("cache: - comparing");
+    bus.debug("cache: - compare");
     return (
       this.cacheFormatVersionCompatible(pCachedCruiseResult) &&
       this.#cacheStrategy.revisionDataEqual(

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

@@ -82,7 +82,7 @@ export default function findContentChanges(
   pCachedCruiseResult,
   pOptions,
 ) {
-  bus.debug("cache: - getting revision data");
+  bus.debug("cache: - get revision data");
   const lFileSet = new Set(
     findAllFiles(pDirectory, {
       baseDir: pOptions.baseDir,
@@ -91,12 +91,12 @@ export default function findContentChanges(
     }).filter(hasInterestingExtension(pOptions.extensions)),
   );
 
-  bus.debug("cache: - getting (cached - new)");
+  bus.debug("cache: - get (cached - new)");
   const lDiffCachedVsNew = pCachedCruiseResult.modules.map(
     diffCachedModuleAgainstFileSet(lFileSet, pOptions.baseDir),
   );
 
-  bus.debug("cache: - getting (new - cached)");
+  bus.debug("cache: - get (new - cached)");
   lDiffCachedVsNew.forEach(({ name }) => lFileSet.delete(name));
 
   const lDiffNewVsCached = [];
@@ -108,6 +108,6 @@ export default function findContentChanges(
     });
   }
 
-  bus.debug("cache: - returning revision data");
+  bus.debug("cache: - return revision data");
   return lDiffCachedVsNew.concat(lDiffNewVsCached);
 }

package/src/cache/metadata-strategy.mjs

@@ -42,9 +42,9 @@ export default class MetaDataStrategy {
       ...pOptions,
     };
     try {
-      bus.debug("cache: - getting sha");
+      bus.debug("cache: - get sha");
       const lSHA = await lOptions.shaRetrievalFn();
-      bus.debug("cache: - getting diff");
+      bus.debug("cache: - get diff");
       const lDiff = /** @type {IChange[]} */ (
         await lOptions.diffListFn({ oldRevision: lSHA })
       );
@@ -55,7 +55,7 @@ export default class MetaDataStrategy {
         )
         .filter(changeHasInterestingExtension(lOptions.extensions))
         .filter(isInterestingChangeType(lOptions.interestingChangeTypes));
-      bus.debug("cache: - sha-summing diff");
+      bus.debug("cache: - sha-sum diff");
       return {
         SHA1: lSHA,
         changes: lChanges.map(lOptions.checksumFn),

package/src/cli/init-config/build-config.mjs

@@ -160,6 +160,36 @@ function buildMainFieldsAttribute(pInitOptions) {
       mainFields: ["main", "types", "typings"],`;
 }
 
+/**
+ * @param {IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildBuiltInModulesAttribute(pInitOptions) {
+  if (pInitOptions.usesBun) {
+    return `
+    /* List of built-in modules to use on top of the ones node declares.
+
+       See https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#builtinmodules-influencing-what-to-consider-built-in--core-modules
+       for details
+    */
+    builtInModules: { 
+      add: [
+        "bun",
+        "bun:ffi",
+        "bun:jsc",
+        "bun:sqlite",
+        "bun:test",
+        "bun:wrap",
+        "detect-libc",
+        "undici",
+        "ws"
+      ]
+    },
+`;
+  }
+  return "";
+}
+
 /**
  * Creates a .dependency-cruiser config with a set of basic validations
  * to the current directory.
@@ -203,6 +233,10 @@ export default function buildConfig(pInitOptions) {
       "{{babelConfigAttribute}}",
       buildBabelConfigAttribute(pInitOptions),
     )
+    .replace(
+      "{{builtInModulesAttribute}}",
+      buildBuiltInModulesAttribute(pInitOptions),
+    )
     .replace("{{extensionsAttribute}}", buildExtensionsAttribute(pInitOptions))
     .replace("{{mainFieldsAttribute}}", buildMainFieldsAttribute(pInitOptions))
     .replace("{{version}}", pInitOptions.version)

package/src/cli/init-config/config-template.mjs

@@ -314,8 +314,7 @@ module.exports = {
          Only works when the 'exportsFields' array is non-empty.
       */
       conditionNames: ["import", "require", "node", "default", "types"],
-      /*
-         The extensions, by default are the same as the ones dependency-cruiser
+      /* The extensions, by default are the same as the ones dependency-cruiser
          can access (run \`npx depcruise --info\` to see which ones that are in
          _your_ environment). If that list is larger than you need you can pass
          the extensions you actually use (e.g. [".js", ".jsx"]). This can speed
@@ -324,26 +323,25 @@ module.exports = {
       {{extensionsAttribute}}
       /* What to consider a 'main' field in package.json */
       {{mainFieldsAttribute}}
-      /*
-         A list of alias fields in package.jsons
+      /* A list of alias fields in package.jsons
+        
          See [this specification](https://github.com/defunctzombie/package-browser-field-spec) and
          the webpack [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealiasfields)
-         documentation 
+         documentation.
          
          Defaults to an empty array (= don't use alias fields).
        */
       // aliasFields: ["browser"],
     },
 
-    /*
-      skipAnalysisNotInRules will make dependency-cruiser execute 
-      analysis strictly necessary for checking the rule set only. 
+    /* skipAnalysisNotInRules will make dependency-cruiser execute 
+       analysis strictly necessary for checking the rule set only. 
 
-      See https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#skipanalysisnotinrules
-      for details
+       See https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#skipanalysisnotinrules
+       for details
      */
     skipAnalysisNotInRules: true,
-
+    {{builtInModulesAttribute}}
     reporterOptions: {
       dot: {
         /* pattern of modules that can be consolidated in the detailed
@@ -369,9 +367,9 @@ module.exports = {
       },
       archi: {
         /* pattern of modules that can be consolidated in the high level
-          graphical dependency graph. If you use the high level graphical
-          dependency graph reporter (\`archi\`) you probably want to tweak
-          this collapsePattern to your situation.
+           graphical dependency graph. If you use the high level graphical
+           dependency graph reporter (\`archi\`) you probably want to tweak
+           this collapsePattern to your situation.
         */
         collapsePattern: '^(?:packages|src|lib(s?)|app(s?)|bin|test(s?)|spec(s?))/[^/]+|node_modules/(?:@[^/]+/[^/]+|[^/]+)',
 

package/src/cli/init-config/environment-helpers.mjs

@@ -99,6 +99,30 @@ export function isLikelyMonoRepo(pFolderNames = getFolderNames(process.cwd())) {
   return pFolderNames.includes("packages");
 }
 
+function getPackageManager(pManifest) {
+  let lReturnValue = "";
+  try {
+    const lManifest = pManifest ?? readManifest();
+    if (Object.hasOwn(lManifest, "packageManager")) {
+      lReturnValue = lManifest.packageManager;
+    }
+  } catch (pError) {
+    // silently ignore - we'll return the empty string anyway then
+  }
+  return lReturnValue;
+}
+
+/**
+ * @param {Record<string,any>} pManifest
+ * @returns {boolean}
+ */
+export function likelyUsesBun(pManifest) {
+  const bunIsPackageManager = getPackageManager(pManifest).startsWith("bun");
+  return (
+    bunIsPackageManager || fileExists("bun.lockb") || fileExists("bunfig.toml")
+  );
+}
+
 export function hasTestsWithinSource(pTestLocations, pSourceLocations) {
   return pTestLocations.every((pTestLocation) =>
     pSourceLocations.includes(pTestLocation),

package/src/cli/init-config/get-user-input.mjs

@@ -16,6 +16,7 @@ import {
   getBabelConfigCandidates,
   hasWebpackConfigCandidates,
   getWebpackConfigCandidates,
+  likelyUsesBun,
 } from "./environment-helpers.mjs";
 import { validateLocation } from "./validators.mjs";
 import { isAvailable as tscIsAvailable } from "#extract/tsc/parse.mjs";
@@ -146,6 +147,12 @@ const QUESTIONS = [
     message: "Full path to your webpack config:",
     choices: getWebpackConfigCandidates().map(toPromptChoice),
   },
+  {
+    name: "usesBun",
+    type: () => (likelyUsesBun() ? "confirm" : false),
+    message: "Looks like you're using bun. Detect its builtins?",
+    initial: true,
+  },
 ];
 
 /**

package/src/cli/init-config/index.mjs

@@ -16,6 +16,7 @@ import {
   getDefaultConfigFileName,
   hasJSConfigCandidates,
   getJSConfigCandidates,
+  likelyUsesBun,
   isTypeModule,
 } from "./environment-helpers.mjs";
 import { writeRunScriptsToManifest } from "./write-run-scripts-to-manifest.mjs";
@@ -50,6 +51,7 @@ function getOneShotConfig(pOneShotConfigId) {
     useBabelConfig: hasBabelConfigCandidates(),
     babelConfig: getBabelConfigCandidates().shift(),
     specifyResolutionExtensions: true,
+    usesBun: likelyUsesBun(),
   };
   /** @type {Map<OneShotConfigIDType, IPartialInitConfig>} */
   const lOneShotConfigs = new Map([

package/src/enrich/enrich-modules.mjs

@@ -17,7 +17,7 @@ import { bus } from "#utl/bus.mjs";
  * @returns {IModule[]}
  */
 export default function enrichModules(pModules, pOptions) {
-  bus.info("analyzing: cycles");
+  bus.info("analyze: cycles");
   const lIndexedModules = new IndexedModuleGraph(pModules);
   let lModules = deriveCycles(pModules, lIndexedModules, {
     pSourceAttribute: "source",
@@ -25,21 +25,21 @@ export default function enrichModules(pModules, pOptions) {
     pSkipAnalysisNotInRules: pOptions.skipAnalysisNotInRules,
     pRuleSet: pOptions.ruleSet,
   });
-  bus.info("analyzing: dependents");
+  bus.info("analyze: dependents");
   lModules = addDependents(lModules, pOptions);
-  bus.info("analyzing: orphans");
+  bus.info("analyze: orphans");
   lModules = deriveOrphans(lModules, pOptions);
-  bus.info("analyzing: reachables");
+  bus.info("analyze: reachables");
   lModules = deriveReachable(lModules, pOptions.ruleSet);
-  bus.info("analyzing: module metrics");
+  bus.info("analyze: module metrics");
   lModules = deriveModuleMetrics(lModules, pOptions);
-  bus.info("analyzing: focus");
+  bus.info("analyze: focus");
   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.info("analyzing: validations");
+  bus.info("analyze: validations");
   lModules = addValidations(lModules, pOptions.ruleSet, pOptions.validate);
 
   lModules = softenKnownViolations(lModules, pOptions.knownViolations);

package/src/enrich/index.mjs

@@ -1,6 +1,7 @@
 import enrichModules from "./enrich-modules.mjs";
 import aggregateToFolders from "./derive/folders/index.mjs";
 import summarize from "./summarize/index.mjs";
+import { bus } from "#utl/bus.mjs";
 
 /**
  * Enriches the passed modules with things like cycle detection, validations,
@@ -17,8 +18,10 @@ import summarize from "./summarize/index.mjs";
  */
 export default function enrich(pModules, pOptions, pFileAndDirectoryArray) {
   const lModules = enrichModules(pModules, pOptions);
+  bus.info("analyze: aggregate to folders");
   const lFolders = aggregateToFolders(lModules, pOptions);
 
+  bus.info("analyze: summary");
   const lReturnValue = {
     modules: lModules,
     ...lFolders,
@@ -26,7 +29,7 @@ export default function enrich(pModules, pOptions, pFileAndDirectoryArray) {
       lModules,
       pOptions,
       pFileAndDirectoryArray,
-      lFolders.folders
+      lFolders.folders,
     ),
   };
 

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

@@ -117,7 +117,7 @@ export default function softenKnownViolations(
   pSoftenedSeverity = "ignore",
 ) {
   if (pKnownViolations) {
-    bus.info("analyzing: comparing against known errors");
+    bus.info("analyze: compare to known errors");
     return pModules.map((pModule) =>
       softenKnownViolation(pModule, pKnownViolations, pSoftenedSeverity),
     );

package/src/extract/helpers.mjs

@@ -28,6 +28,37 @@ export function detectPreCompilationNess(pTSDependencies, pJSDependencies) {
   );
 }
 
+const PROTOCOL_ONLY_BUILTINS = new Set([
+  // module.builtinModules.filter(m=>m.startsWith('node:'))
+  "node:sea",
+  "node:sqlite",
+  "node:test",
+  "node:test/reporters",
+  // module.builtinModules.filter(m=>m.startsWith('bun:'))
+  "bun:ffi",
+  "bun:jsc",
+  "bun:sqlite",
+  "bun:test",
+  "bun:wrap",
+]);
+
+/**
+ * Given a module name returns the canonical module name.
+ * @param {string} pProtocol
+ * @param {string} pModuleName
+ * @returns {string}
+ */
+function getCanonicalModuleName(pModuleName, pProtocol) {
+  const lModuleWithProtocol = pProtocol + pModuleName;
+  const lIsJsIshProtocol = pProtocol === "node:" || pProtocol === "bun:";
+  const lIsProtocolOnlyModule = PROTOCOL_ONLY_BUILTINS.has(lModuleWithProtocol);
+
+  if (!lIsJsIshProtocol || lIsProtocolOnlyModule) {
+    return lModuleWithProtocol;
+  }
+  return pModuleName;
+}
+
 /**
  * Given a module string returns in an object
  * - the module name
@@ -42,15 +73,19 @@ export function detectPreCompilationNess(pTSDependencies, pJSDependencies) {
  * @param {string} pString
  * @returns {{module:string; protocol?:string; mimeType?:string}}
  */
+// eslint-disable-next-line complexity
 export function extractModuleAttributes(pString) {
   let lReturnValue = { module: pString };
   const lModuleAttributes = pString.match(
     // eslint-disable-next-line security/detect-unsafe-regex
-    /^(?<protocol>node:|file:|data:)(?:(?<mimeType>[^,]+),)?(?<module>.+)$/,
+    /^(?<protocol>node:|file:|data:|bun:)(?:(?<mimeType>[^,]+),)?(?<module>.+)$/,
   );
 
   if (lModuleAttributes?.groups) {
-    lReturnValue.module = lModuleAttributes?.groups.module;
+    lReturnValue.module = getCanonicalModuleName(
+      lModuleAttributes?.groups.module,
+      lModuleAttributes?.groups.protocol,
+    );
     if (lModuleAttributes?.groups?.protocol) {
       lReturnValue.protocol = lModuleAttributes.groups.protocol;
     }
@@ -77,6 +112,7 @@ export function stripQueryParameters(pFilenameString) {
   // deprecated, hence this funky RE replace. And accompanying unit test :-/
   return pFilenameString.replace(/\?.+$/, "");
 }
+
 /**
  * Returns true if the file name has a TypeScript compatible extension
  * @param {string} pFileName

package/src/extract/index.mjs

@@ -75,13 +75,13 @@ function extractFileDirectoryArray(
 ) {
   let lVisited = new Set();
 
-  bus.info("reading files: gathering initial sources");
+  bus.info("read files: gather initial sources");
   const lInitialSources = gatherInitialSources(
     pFileDirectoryArray,
     pCruiseOptions,
   );
 
-  bus.info("reading files: visiting dependencies");
+  bus.info("read files: visit dependencies");
   return lInitialSources.reduce((pDependencies, pFilename) => {
     if (!lVisited.has(pFilename)) {
       lVisited.add(pFilename);

package/src/extract/resolve/is-built-in.mjs

@@ -1,28 +1,30 @@
-import { builtinModules } from "node:module";
-
-function getBuiltIns(pResolveOptions) {
-  // builtinModules does not expose all builtin modules for #reasons -
-  // see https://github.com/nodejs/node/issues/42785. In stead we could use
-  // isBuiltin, but that is not available in node 16.14, the lowest version
-  // of node dependency-cruiser currently supports. So we add the missing
-  // modules here.
-  let lReturnValue = builtinModules.concat(["test", "node:test"]);
-
-  if (pResolveOptions?.builtInModules?.override) {
-    lReturnValue = pResolveOptions?.builtInModules?.override;
-  }
-  if (pResolveOptions?.builtInModules?.add) {
-    lReturnValue = lReturnValue.concat(pResolveOptions.builtInModules.add);
-  }
-  return lReturnValue;
-}
+import { isBuiltin as moduleIsBuiltin } from "node:module";
 
 /**
- *
  * @param {string} pModuleName - the unresolved module name
  * @param {*} pResolveOptions
  * @returns {boolean} - true if the module is a built-in module
  */
 export function isBuiltin(pModuleName, pResolveOptions) {
-  return getBuiltIns(pResolveOptions).includes(pModuleName);
+  if (pResolveOptions?.builtInModules?.override) {
+    return pResolveOptions.builtInModules.override.includes(pModuleName);
+  }
+
+  // bun, as it turns out, has some additional builtin modules. Even when running
+  // dependency-cruiser with bunx, bunx will use node by default. To cover that scenario
+  // there's three options
+  // - tell everyone to run bunx with the --bun option, so bun uses bun instead of node
+  //   and hope everyone actually does that and it doesn't lead to a bunch of questions
+  //   in the issues section. I don't expect that to happen anytime soon => other options
+  // - add the bun builtins here.
+  //   this sounds attractive, but some of the modules ('undici', 'ws') are
+  //   also npm packages. In nodejs context that will lead to a.o. false
+  //   classifications.
+  // - add the bun builtins in dependency-cruiser.js
+  //   Current approach. The --init command will try to detect whether it's
+  //   in a bun repo and add the bun builtins to the config.
+  return (
+    moduleIsBuiltin(pModuleName) ||
+    (pResolveOptions?.builtInModules?.add ?? []).includes(pModuleName)
+  );
 }

package/src/main/cruise.mjs

@@ -18,7 +18,7 @@ export default async function cruise(
   pResolveOptions,
   pTranspileOptions,
 ) {
-  bus.summary("parsing options", c(1));
+  bus.summary("parse options", c(1));
   const lCruiseOptionsValid = assertCruiseOptionsValid(pCruiseOptions);
   /** @type {import("../../types/strict-options.js").IStrictCruiseOptions} */
   let lCruiseOptions = normalizeCruiseOptions(
@@ -29,7 +29,7 @@ export default async function cruise(
 
   if (lCruiseOptions.cache) {
     bus.summary(
-      `cache: checking freshness with ${lCruiseOptions.cache.strategy}`,
+      `cache: check freshness with ${lCruiseOptions.cache.strategy}`,
       c(2),
     );
 
@@ -41,12 +41,12 @@ export default async function cruise(
     const lCachedResults = await lCache.read(lCruiseOptions.cache.folder);
 
     if (await lCache.canServeFromCache(lCruiseOptions, lCachedResults)) {
-      bus.summary("cache: reporting from cache", c(8));
+      bus.summary("cache: report from cache", c(8));
       return await reportWrap(lCachedResults, lCruiseOptions);
     }
   }
 
-  bus.summary("importing analytical modules", c(3));
+  bus.summary("import analytical modules", c(3));
   const [
     { default: normalizeRuleSet },
     { default: assertRuleSetValid },
@@ -66,7 +66,7 @@ export default async function cruise(
   ]);
 
   if (lCruiseOptions.ruleSet) {
-    bus.summary("parsing rule set", c(4));
+    bus.summary("parse rule set", c(4));
     lCruiseOptions.ruleSet = normalizeRuleSet(
       assertRuleSetValid(lCruiseOptions.ruleSet),
     );
@@ -76,14 +76,14 @@ export default async function cruise(
     pFileAndDirectoryArray,
   );
 
-  bus.summary("determining how to resolve", c(5));
+  bus.summary("determine how to resolve", c(5));
   const lNormalizedResolveOptions = await normalizeResolveOptions(
     pResolveOptions,
     lCruiseOptions,
     pTranspileOptions?.tsConfig,
   );
 
-  bus.summary("reading files", c(6));
+  bus.summary("read files", c(6));
   const lExtractionResult = extract(
     lNormalizedFileAndDirectoryArray,
     lCruiseOptions,
@@ -91,7 +91,7 @@ export default async function cruise(
     pTranspileOptions,
   );
 
-  bus.summary("analyzing", c(7));
+  bus.summary("analyze", c(7));
   const lCruiseResult = enrich(
     lExtractionResult,
     lCruiseOptions,
@@ -99,10 +99,10 @@ export default async function cruise(
   );
 
   if (lCruiseOptions.cache) {
-    bus.summary("cache: saving", c(8));
+    bus.summary("cache: save", c(8));
     await lCache.write(lCruiseOptions.cache.folder, lCruiseResult);
   }
 
-  bus.summary("reporting", c(9));
+  bus.summary("report", c(9));
   return await reportWrap(lCruiseResult, lCruiseOptions);
 }

package/src/meta.cjs

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "16.9.0",
+  version: "16.10.0",
   engines: {
     node: "^18.17||>=20",
   },

package/src/report/dot/index.mjs

@@ -25,15 +25,15 @@ const GRANULARITY2REPORTER_OPTIONS = new Map([
 ]);
 
 function buildGraphAttributes(pGraph) {
-  return pGraph ? `    ${attributizeObject(pGraph || {})}` : "";
+  return pGraph ? `    ${attributizeObject(pGraph)}` : "";
 }
 
 function buildNodeAttributes(pNode) {
-  return pNode ? `    node [${attributizeObject(pNode || {})}]` : "";
+  return pNode ? `    node [${attributizeObject(pNode)}]` : "";
 }
 
 function buildEdgeAttributes(pEdge) {
-  return pEdge ? `    edge [${attributizeObject(pEdge || {})}]` : "";
+  return pEdge ? `    edge [${attributizeObject(pEdge)}]` : "";
 }
 
 function buildGeneralAttributes(pTheme) {