dependency-cruiser 13.0.0-beta-2 → 13.0.0-beta-4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "13.0.0-beta-2",
+  "version": "13.0.0-beta-4",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -97,7 +97,7 @@
     "depcruise:graph:doc:samples": "sh tools/generate-samples.sh",
     "depcruise:graph:mermaid": "node ./bin/dependency-cruise.mjs bin src --include-only ^src/ --collapse 2 --output-type mermaid",
     "depcruise:graph:mermaid:diff": "node ./bin/dependency-cruise.mjs bin src test types tools --config configs/.dependency-cruiser-unlimited.json --output-type mermaid --reaches \"$(watskeburt $SHA)\"",
-    "depcruise:graph:view": "node ./bin/dependency-cruise.mjs bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.mjs --output-type dot --progress cli-feedback --highlight \"$(watskeburt v13)\" | dot -T svg | node ./bin/wrap-stream-in-html.mjs | browser",
+    "depcruise:graph:view": "node ./bin/dependency-cruise.mjs bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.mjs --output-type dot --progress cli-feedback --highlight \"$(watskeburt develop)\" | dot -T svg | node ./bin/wrap-stream-in-html.mjs | browser",
     "depcruise:graph:view:diff": "node ./bin/dependency-cruise.mjs bin src test --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-unlimited.json --output-type dot --progress cli-feedback --reaches \"$(watskeburt develop)\" | dot -T svg | node ./bin/wrap-stream-in-html.mjs | browser",
     "depcruise:report": "node ./bin/dependency-cruise.mjs src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.mjs --output-to dependency-violations.html",
     "depcruise:report:view": "node ./bin/dependency-cruise.mjs src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.mjs --output-to - | browser",
@@ -126,14 +126,16 @@
     "scm:push:gitlab-mirror:commits": "git push gitlab-mirror",
     "scm:push:gitlab-mirror:tags": "git push --tags gitlab-mirror",
     "scm:stage": "git add .",
-    "test": "LANG=en_US.UTF-8 mocha",
-    "test:i": "LANG=en_US.UTF-8 mocha --grep \"^\\[[I]\\]\"",
-    "test:u": "LANG=en_US.UTF-8 mocha --grep \"^\\[[U]\\]\"",
-    "test:e": "LANG=en_US.UTF-8 mocha --grep \"^\\[[E]\\]\"",
-    "test:cover": "LANG=en_US.UTF-8 c8 mocha",
+    "test": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha",
+    "test:i": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha --grep \"^\\[[I]\\]\"",
+    "test:u": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha --grep \"^\\[[U]\\]\"",
+    "test:e": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha --grep \"^\\[[E]\\]\"",
+    "test:cover": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings c8 mocha",
     "test:glob": "set -f && test \"`bin/dependency-cruise.mjs --no-config test/extract/__mocks__/gather-globbing/packages/**/src/**/*.js | grep \"no dependency violations found\"`\" = \"✔ no dependency violations found (6 modules, 0 dependencies cruised)\"",
     "test:load": "hyperfine --warmup 3 --runs 30 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --no-cache --no-progress\"",
     "test:load:short": "hyperfine --warmup 1 --runs 5 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --no-cache --no-progress\"",
+    "test:load:cached": "hyperfine --warmup 3 --runs 30 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --cache node_modules/.cache/dependency-cruiser/load-cached --no-progress\"",
+    "test:load:cached:short": "hyperfine --warmup 1 --runs 5 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --cache node_modules/.cache/dependency-cruiser/load-cached --no-progress\"",
     "update-dependencies": "npm-run-all upem:update upem:install build:clean build lint:eslint:clear-caches lint:fix depcruise test:cover",
     "upem-outdated": "npm outdated --json --long | upem --dry-run",
     "upem:install": "npm install",
@@ -149,10 +151,10 @@
     "ajv": "8.12.0",
     "chalk": "5.2.0",
     "commander": "10.0.1",
-    "enhanced-resolve": "5.12.0",
+    "enhanced-resolve": "5.13.0",
     "figures": "5.0.0",
     "get-stream": "^6.0.1",
-    "glob": "10.1.0",
+    "glob": "10.2.2",
     "handlebars": "4.7.7",
     "ignore": "5.2.4",
     "indent-string": "5.0.0",
@@ -163,7 +165,7 @@
     "prompts": "2.4.2",
     "rechoir": "^0.8.0",
     "safe-regex": "2.1.1",
-    "semver": "^7.4.0",
+    "semver": "^7.5.0",
     "semver-try-require": "6.2.2",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.0.1",
@@ -174,18 +176,18 @@
     "@babel/core": "7.21.4",
     "@babel/plugin-transform-modules-commonjs": "7.21.2",
     "@babel/preset-typescript": "7.21.4",
-    "@swc/core": "1.3.50",
+    "@swc/core": "1.3.53",
     "@types/lodash": "4.14.194",
-    "@types/node": "18.15.11",
+    "@types/node": "18.16.0",
     "@types/prompts": "2.4.4",
-    "@typescript-eslint/eslint-plugin": "5.58.0",
-    "@typescript-eslint/parser": "5.58.0",
+    "@typescript-eslint/eslint-plugin": "5.59.0",
+    "@typescript-eslint/parser": "5.59.0",
     "@vue/compiler-sfc": "3.2.47",
     "c8": "7.13.0",
     "chai": "4.3.7",
     "chai-json-schema": "1.5.1",
     "coffeescript": "2.7.0",
-    "eslint": "8.38.0",
+    "eslint": "8.39.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -201,7 +203,7 @@
     "mocha": "10.2.0",
     "normalize-newline": "4.1.0",
     "npm-run-all": "4.1.5",
-    "prettier": "2.8.7",
+    "prettier": "2.8.8",
     "proxyquire": "2.1.3",
     "shx": "0.3.4",
     "svelte": "3.58.0",

package/src/cli/index.mjs

@@ -9,19 +9,13 @@ import chalk from "chalk";
 import { cruise } from "../main/index.mjs";
 import bus from "../utl/bus.mjs";
 
-import extractTSConfig from "../config-utl/extract-ts-config.mjs";
-import extractBabelConfig from "../config-utl/extract-babel-config.mjs";
-import extractWebpackResolveConfig from "../config-utl/extract-webpack-resolve-config.mjs";
-import extractKnownViolations from "../config-utl/extract-known-violations.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";
-import formatMetaInfo from "./format-meta-info.mjs";
 import setUpCliFeedbackListener from "./listeners/cli-feedback.mjs";
 import setUpPerformanceLogListener from "./listeners/performance-log/index.mjs";
 import setUpNDJSONListener from "./listeners/ndjson.mjs";
-import initConfig from "./init-config/index.mjs";
 
 async function extractResolveOptions(pCruiseOptions) {
   let lResolveOptions = {};
@@ -29,7 +23,10 @@ async function extractResolveOptions(pCruiseOptions) {
     pCruiseOptions?.ruleSet?.options?.webpackConfig?.fileName ?? null;
 
   if (lWebPackConfigFileName) {
-    lResolveOptions = await extractWebpackResolveConfig(
+    const extractWebpackResolveConfig = await import(
+      "../config-utl/extract-webpack-resolve-config.mjs"
+    );
+    lResolveOptions = await extractWebpackResolveConfig.default(
       lWebPackConfigFileName,
       pCruiseOptions?.ruleSet?.options?.webpackConfig?.env ?? null,
       pCruiseOptions?.ruleSet?.options?.webpackConfig?.arguments ?? null
@@ -38,9 +35,12 @@ async function extractResolveOptions(pCruiseOptions) {
   return lResolveOptions;
 }
 
-function addKnownViolations(pCruiseOptions) {
+async function addKnownViolations(pCruiseOptions) {
   if (pCruiseOptions.knownViolationsFile) {
-    const lKnownViolations = extractKnownViolations(
+    const extractKnownViolations = await import(
+      "../config-utl/extract-known-violations.mjs"
+    );
+    const lKnownViolations = extractKnownViolations.default(
       pCruiseOptions.knownViolationsFile
     );
 
@@ -53,25 +53,28 @@ function addKnownViolations(pCruiseOptions) {
   return pCruiseOptions;
 }
 
-function extractTSConfigOptions(pCruiseOptions) {
+async function extractTSConfigOptions(pCruiseOptions) {
   let lReturnValue = {};
   const lTSConfigFileName =
     pCruiseOptions?.ruleSet?.options?.tsConfig?.fileName ?? null;
 
   if (lTSConfigFileName) {
-    lReturnValue = extractTSConfig(lTSConfigFileName);
+    const extractTSConfig = await import("../config-utl/extract-ts-config.mjs");
+    lReturnValue = extractTSConfig.default(lTSConfigFileName);
   }
 
   return lReturnValue;
 }
 
-function extractBabelConfigOptions(pCruiseOptions) {
+async function extractBabelConfigOptions(pCruiseOptions) {
   let lReturnValue = {};
   const lBabelConfigFileName =
     pCruiseOptions?.ruleSet?.options?.babelConfig?.fileName ?? null;
-
   if (lBabelConfigFileName) {
-    lReturnValue = extractBabelConfig(lBabelConfigFileName);
+    const extractBabelConfig = await import(
+      "../config-utl/extract-babel-config.mjs"
+    );
+    lReturnValue = extractBabelConfig.default(lBabelConfigFileName);
   }
 
   return lReturnValue;
@@ -99,7 +102,7 @@ function setUpListener(pCruiseOptions) {
 }
 
 async function runCruise(pFileDirectoryArray, pCruiseOptions) {
-  const lCruiseOptions = addKnownViolations(
+  const lCruiseOptions = await addKnownViolations(
     await normalizeCliOptions(pCruiseOptions)
   );
 
@@ -120,7 +123,7 @@ async function runCruise(pFileDirectoryArray, pCruiseOptions) {
     lCruiseOptions,
     await extractResolveOptions(lCruiseOptions),
     {
-      tsConfig: extractTSConfigOptions(lCruiseOptions),
+      tsConfig: await extractTSConfigOptions(lCruiseOptions),
       babelConfig: await extractBabelConfigOptions(lCruiseOptions),
     }
   );
@@ -159,9 +162,11 @@ export default async function executeCli(pFileDirectoryArray, pCruiseOptions) {
     }
     /* c8 ignore stop */
     if (lCruiseOptions.info === true) {
-      process.stdout.write(formatMetaInfo());
+      const formatMetaInfo = await import("./format-meta-info.mjs");
+      process.stdout.write(await formatMetaInfo.default());
     } else if (lCruiseOptions.init) {
-      initConfig(lCruiseOptions.init);
+      const initConfig = await import("./init-config/index.mjs");
+      initConfig.default(lCruiseOptions.init);
     } else {
       lExitCode = await runCruise(pFileDirectoryArray, lCruiseOptions);
     }

package/src/extract/gather-initial-sources.mjs

@@ -90,6 +90,10 @@ function gatherScannableFilesFromDirectory(pDirectoryName, pOptions) {
 export default function gatherInitialSources(pFileAndDirectoryArray, pOptions) {
   const lOptions = { baseDir: process.cwd(), ...pOptions };
 
+  // these are `.reduce`s and not `.map`s because they typically return larger
+  // arrays than the pFileAndDirectoryArray:
+  // - `glob` returns an array of strings
+  // - so does `gatherScannableFilesFromDirectory`
   return pFileAndDirectoryArray
     .reduce(
       (pAll, pFileOrDirectory) =>

package/src/main/index.mjs

@@ -3,18 +3,14 @@
 
 import Ajv from "ajv";
 
-import extract from "../extract/index.mjs";
-import enrich from "../enrich/index.mjs";
 import cruiseResultSchema from "../schema/cruise-result.schema.mjs";
 import bus from "../utl/bus.mjs";
-import Cache from "../cache/cache.mjs";
 import {
   allExtensions,
   getAvailableTranspilers,
 } from "../extract/transpile/meta.mjs";
 import normalizeFilesAndDirectories from "./files-and-dirs/normalize.mjs";
 import validateRuleSet from "./rule-set/validate.mjs";
-import normalizeRuleSet from "./rule-set/normalize.mjs";
 import {
   validateCruiseOptions,
   validateFormatOptions,
@@ -23,7 +19,6 @@ import {
   normalizeCruiseOptions,
   normalizeFormatOptions,
 } from "./options/normalize.mjs";
-import normalizeResolveOptions from "./resolve-options/normalize.mjs";
 import reportWrap from "./report-wrap.mjs";
 
 const TOTAL_STEPS = 9;
@@ -74,6 +69,8 @@ export async function cruise(
       c(2)
     );
 
+    const CacheModule = await import("../cache/cache.mjs");
+    const Cache = CacheModule.default;
     lCache = new Cache(lCruiseOptions.cache.strategy);
     const lCachedResults = lCache.read(lCruiseOptions.cache.folder);
 
@@ -85,7 +82,8 @@ export async function cruise(
 
   if (Boolean(lCruiseOptions.ruleSet)) {
     bus.emit("progress", "parsing rule set", c(3));
-    lCruiseOptions.ruleSet = normalizeRuleSet(
+    const normalizeRuleSet = await import("./rule-set/normalize.mjs");
+    lCruiseOptions.ruleSet = normalizeRuleSet.default(
       validateRuleSet(lCruiseOptions.ruleSet)
     );
   }
@@ -95,14 +93,16 @@ export async function cruise(
   );
 
   bus.emit("progress", "determining how to resolve", c(4));
-  const lNormalizedResolveOptions = await normalizeResolveOptions(
+  let normalizeResolveOptions = await import("./resolve-options/normalize.mjs");
+  const lNormalizedResolveOptions = await normalizeResolveOptions.default(
     pResolveOptions,
     lCruiseOptions,
     pTranspileOptions?.tsConfig
   );
 
   bus.emit("progress", "reading files", c(5));
-  const lExtractionResult = extract(
+  const extract = await import("../extract/index.mjs");
+  const lExtractionResult = extract.default(
     lNormalizedFileAndDirectoryArray,
     lCruiseOptions,
     lNormalizedResolveOptions,
@@ -110,7 +110,8 @@ export async function cruise(
   );
 
   bus.emit("progress", "analyzing", c(6));
-  const lCruiseResult = enrich(
+  const enrich = await import("../enrich/index.mjs");
+  const lCruiseResult = enrich.default(
     lExtractionResult,
     lCruiseOptions,
     lNormalizedFileAndDirectoryArray

package/src/meta.js

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

package/src/report/dot/dot-custom.mjs

@@ -0,0 +1,3 @@
+import dotBase from "./index.mjs";
+
+export default dotBase("custom");

package/src/report/dot/dot-flat.mjs

@@ -0,0 +1,3 @@
+import dotBase from "./index.mjs";
+
+export default dotBase("flat");

package/src/report/dot/dot-folder.mjs

@@ -0,0 +1,3 @@
+import dotBase from "./index.mjs";
+
+export default dotBase("folder");

package/src/report/dot/dot-module.mjs

@@ -0,0 +1,3 @@
+import dotBase from "./index.mjs";
+
+export default dotBase("module");

package/src/report/index.mjs

@@ -1,45 +1,25 @@
-import anon from "./anon/index.mjs";
-import csv from "./csv.mjs";
-import dotBase from "./dot/index.mjs";
-import errorHtml from "./error-html/index.mjs";
-import error from "./error.mjs";
-import errorLong from "./error-long.mjs";
-import html from "./html/index.mjs";
-import identity from "./identity.mjs";
-import json from "./json.mjs";
-import teamcity from "./teamcity.mjs";
-import text from "./text.mjs";
-import baseline from "./baseline.mjs";
-import metrics from "./metrics.mjs";
 import { getExternalPluginReporter } from "./plugins.mjs";
-import markdown from "./markdown.mjs";
-import mermaid from "./mermaid.mjs";
 
-const dot = dotBase("module");
-const ddot = dotBase("folder");
-const cdot = dotBase("custom");
-const fdot = dotBase("flat");
-
-const TYPE2REPORTER = {
-  anon,
-  csv,
-  dot,
-  ddot,
-  cdot,
-  archi: cdot,
-  fdot,
-  flat: fdot,
-  "err-html": errorHtml,
-  markdown,
-  "err-long": errorLong,
-  err: error,
-  html,
-  json,
-  teamcity,
-  text,
-  baseline,
-  metrics,
-  mermaid,
+const TYPE2MODULE = {
+  anon: "./anon/index.mjs",
+  csv: "./csv.mjs",
+  dot: "./dot/dot-module.mjs",
+  ddot: "./dot/dot-folder.mjs",
+  cdot: "./dot/dot-custom.mjs",
+  archi: "./dot/dot-custom.mjs",
+  fdot: "./dot/dot-flat.mjs",
+  flat: "./dot/dot-flat.mjs",
+  "err-html": "./error-html/index.mjs",
+  markdown: "./markdown.mjs",
+  "err-long": "./error-long.mjs",
+  err: "./error.mjs",
+  html: "./html/index.mjs",
+  json: "./json.mjs",
+  teamcity: "./teamcity.mjs",
+  text: "./text.mjs",
+  baseline: "./baseline.mjs",
+  metrics: "./metrics.mjs",
+  mermaid: "./mermaid.mjs",
 };
 
 /**
@@ -52,12 +32,17 @@ const TYPE2REPORTER = {
  *                       and returns an IReporterOutput
  */
 async function getReporter(pOutputType) {
-  return (
-    // eslint-disable-next-line security/detect-object-injection
-    TYPE2REPORTER[pOutputType] ||
-    (await getExternalPluginReporter(pOutputType)) ||
-    identity
-  );
+  let lReturnValue = {};
+  if (pOutputType?.startsWith("plugin:")) {
+    lReturnValue = await getExternalPluginReporter(pOutputType);
+  } else {
+    const lModuleToImport =
+      // eslint-disable-next-line security/detect-object-injection
+      TYPE2MODULE[pOutputType] || "./identity.mjs";
+    const lModule = await import(lModuleToImport);
+    lReturnValue = lModule.default;
+  }
+  return lReturnValue;
 }
 
 /**
@@ -66,7 +51,7 @@ async function getReporter(pOutputType) {
  * @returns {import("../../types/shared-types.js").OutputType[]} -
  */
 function getAvailableReporters() {
-  return Object.keys(TYPE2REPORTER);
+  return Object.keys(TYPE2MODULE);
 }
 
 export default {