dependency-cruiser 12.11.1 → 13.0.0-beta-2

package/src/cache/{find-content-changes.js → find-content-changes.mjs}

@@ -1,14 +1,16 @@
-const { join } = require("path").posix;
-const bus = require("../utl/bus");
-const { DEBUG } = require("../utl/bus-log-levels");
-const findAllFiles = require("../utl/find-all-files");
-const {
+import { join } from "node:path/posix";
+import bus from "../utl/bus.mjs";
+import busLogLevels from "../utl/bus-log-levels.mjs";
+import findAllFiles from "../utl/find-all-files.mjs";
+import {
   getFileHash,
   excludeFilter,
   includeOnlyFilter,
   hasInterestingExtension,
   moduleIsInterestingForDiff,
-} = require("./utl");
+} from "./helpers.mjs";
+
+const { DEBUG } = busLogLevels;
 
 /**
  * @param {Set<string>} pFileSet
@@ -68,7 +70,7 @@ function diffCachedModuleAgainstFileSet(
  * @param {string} pOptions.baseDir
  * @returns {{source: string; changeType: import("watskeburt").changeTypeType; checksum: string}[]}
  */
-module.exports = function findContentChanges(
+export default function findContentChanges(
   pDirectory,
   pCachedCruiseResult,
   pOptions
@@ -101,4 +103,4 @@ module.exports = function findContentChanges(
 
   bus.emit("progress", "cache: - returning revision data", { level: DEBUG });
   return lDiffCachedVsNew.concat(lDiffNewVsCached);
-};
+}

package/src/cache/{utl.js → helpers.mjs}

@@ -1,8 +1,9 @@
-const { createHash } = require("crypto");
-const { readFileSync } = require("fs");
-const path = require("path");
-const memoize = require("lodash/memoize");
-const { filenameMatchesPattern } = require("../graph-utl/match-facade");
+/* eslint-disable import/exports-last */
+import { createHash } from "node:crypto";
+import { readFileSync } from "node:fs";
+import { extname } from "node:path";
+import memoize from "lodash/memoize.js";
+import { filenameMatchesPattern } from "../graph-utl/match-facade.mjs";
 
 /**
  * @param {string} pString
@@ -24,13 +25,13 @@ function _getFileHash(pFileName) {
   }
 }
 
-const getFileHash = memoize(_getFileHash);
+export const getFileHash = memoize(_getFileHash);
 
 /**
  * @param {import("watskeburt").IChange} pChange
- * @param {import("../..").IRevisionChange}
+ * @param {import("../../types/dependency-cruiser.js").IRevisionChange}
  */
-function addCheckSumToChange(pChange) {
+export function addCheckSumToChange(pChange) {
   return {
     ...pChange,
     checksum: getFileHash(pChange.name),
@@ -39,10 +40,10 @@ function addCheckSumToChange(pChange) {
 
 /**
  *
- * @param {import("../../types/strict-filter-types").IStrictExcludeType} pExcludeOption
+ * @param {import("../../types/strict-filter-types.js").IStrictExcludeType} pExcludeOption
  * @returns {(pFileName: string) => boolean}
  */
-function excludeFilter(pExcludeOption) {
+export function excludeFilter(pExcludeOption) {
   return (pFileName) => {
     if (pExcludeOption.path) {
       return !filenameMatchesPattern(pFileName, pExcludeOption.path);
@@ -52,10 +53,10 @@ function excludeFilter(pExcludeOption) {
 }
 
 /**
- * @param {import("../../types/strict-filter-types").IStrictIncludeOnlyType} pIncludeOnlyFilter
+ * @param {import("../../types/strict-filter-types.js").IStrictIncludeOnlyType} pIncludeOnlyFilter
  * @returns {(pFileName: string) => boolean}
  */
-function includeOnlyFilter(pIncludeOnlyFilter) {
+export function includeOnlyFilter(pIncludeOnlyFilter) {
   return (pFileName) => {
     if (pIncludeOnlyFilter) {
       return filenameMatchesPattern(pFileName, pIncludeOnlyFilter.path);
@@ -67,15 +68,15 @@ function includeOnlyFilter(pIncludeOnlyFilter) {
  * @param {Set<string>} pExtensions
  * @returns {(pFileName: string) => boolean}
  */
-function hasInterestingExtension(pExtensions) {
-  return (pFileName) => pExtensions.has(path.extname(pFileName));
+export function hasInterestingExtension(pExtensions) {
+  return (pFileName) => pExtensions.has(extname(pFileName));
 }
 
 /**
  * @param {Set<string>} pExtensions
  * @returns {(pChange: import("watskeburt").IChange) => boolean}
  */
-function changeHasInterestingExtension(pExtensions) {
+export function changeHasInterestingExtension(pExtensions) {
   return (pChange) =>
     hasInterestingExtension(pExtensions)(pChange.name) ||
     (pChange.oldName && hasInterestingExtension(pExtensions)(pChange.oldName));
@@ -96,7 +97,7 @@ const DEFAULT_INTERESTING_CHANGE_TYPES = new Set([
  * @param {Set<import("watskeburt").changeTypeType>} pInterestingChangeTypes
  * @returns {(pChange: import("watskeburt").IChange) => boolean}
  */
-function isInterestingChangeType(pInterestingChangeTypes) {
+export function isInterestingChangeType(pInterestingChangeTypes) {
   return (pChange) =>
     (pInterestingChangeTypes ?? DEFAULT_INTERESTING_CHANGE_TYPES).has(
       pChange.changeType
@@ -106,7 +107,7 @@ function isInterestingChangeType(pInterestingChangeTypes) {
 /**
  * @param {pModule:import("../..").IModule} pModule
  */
-function moduleIsInterestingForDiff(pModule) {
+export function moduleIsInterestingForDiff(pModule) {
   return (
     !pModule.consolidated &&
     !pModule.coreModule &&
@@ -117,14 +118,3 @@ function moduleIsInterestingForDiff(pModule) {
     pModule.followable !== false
   );
 }
-
-module.exports = {
-  getFileHash,
-  excludeFilter,
-  includeOnlyFilter,
-  hasInterestingExtension,
-  changeHasInterestingExtension,
-  isInterestingChangeType,
-  addCheckSumToChange,
-  moduleIsInterestingForDiff,
-};

package/src/cache/{metadata-strategy.js → metadata-strategy.mjs}

@@ -1,25 +1,25 @@
-const { isDeepStrictEqual } = require("util");
-const { getSHASync, listSync } = require("watskeburt");
-const {
+import { isDeepStrictEqual } from "node:util";
+import { getSHASync, listSync } from "watskeburt";
+import {
   isInterestingChangeType,
   addCheckSumToChange,
   excludeFilter,
   includeOnlyFilter,
   changeHasInterestingExtension,
-} = require("./utl");
+} from "./helpers.mjs";
 
-module.exports = class MetaDataStrategy {
+export default class MetaDataStrategy {
   /**
    * @param {Set<string>} pExtensions
    * @param {Set<import("watskeburt").changeTypeType>} pInterestingChangeTypes
-   * @param {import("../../types/strict-options").IStrictCruiseOptions} pCruiseOptions
+   * @param {import("../../types/strict-options.js").IStrictCruiseOptions} pCruiseOptions
    * @param {Object} pOptions
    * @param {Set<string>} pOptions.extensions
    * @param {Set<import("watskeburt").changeTypeType>} pOptions.interestingChangeTypes
    * @param {() => string} pOptions.shaRetrievalFn
    * @param {(pString:string) => Array<import("watskeburt").IChange>} pOptions.diffListFn
    * @param {(import("watskeburt").IChange) => import("../..").IRevisionChange} pOptions.checksumFn
-   * @returns {import("../..").IRevisionData}
+   * @returns {import("../../types/dependency-cruiser.js").IRevisionData}
    */
   getRevisionData(pDirectory, pCachedCruiseResult, pCruiseOptions, pOptions) {
     const lOptions = {
@@ -44,16 +44,14 @@ module.exports = class MetaDataStrategy {
       };
     } catch (pError) {
       throw new Error(
-        "The --cache option works in concert with git - and it seems either the " +
-          "current folder isn't version managed or git isn't installed. Error:" +
-          `\n\n          ${pError}\n`
+        `The --cache option works in concert with git - and it seems either the current folder isn't version managed or git isn't installed. Error:${`\n\n          ${pError}\n`}`
       );
     }
   }
 
   /**
-   * @param {import("../..").IRevisionData} pExistingRevisionData
-   * @param {import("../..").IRevisionData} pNewRevisionData
+   * @param {import("../../types/dependency-cruiser.js").IRevisionData} pExistingRevisionData
+   * @param {import("../../types/dependency-cruiser.js").IRevisionData} pNewRevisionData
    * @returns {boolean}
    */
   revisionDataEqual(pExistingRevisionData, pNewRevisionData) {
@@ -66,9 +64,9 @@ module.exports = class MetaDataStrategy {
   }
 
   /**
-   * @param {import("../..").ICruiseResult} pCruiseResult
-   * @param {import("../..").IRevisionData} pRevisionData
-   * @returns {import("../..").ICruiseResult}
+   * @param {import("../../types/dependency-cruiser.js").ICruiseResult} pCruiseResult
+   * @param {import("../../types/dependency-cruiser.js").IRevisionData} pRevisionData
+   * @returns {import("../../types/dependency-cruiser.js").ICruiseResult}
    */
   prepareRevisionDataForSaving(pCruiseResult, pRevisionData) {
     return pRevisionData
@@ -78,4 +76,4 @@ module.exports = class MetaDataStrategy {
         }
       : pCruiseResult;
   }
-};
+}

package/src/cache/{options-compatible.js → options-compatible.mjs}

@@ -1,4 +1,4 @@
-const { isDeepStrictEqual } = require("util");
+import { isDeepStrictEqual } from "node:util";
 
 /*
 # command line options
@@ -53,29 +53,29 @@ const { isDeepStrictEqual } = require("util");
 - knownViolations
 */
 
-function includeOnlyIsCompatible(pExistingFilter, pNewFilter) {
+export function includeOnlyIsCompatible(pExistingFilter, pNewFilter) {
   return (
     !pExistingFilter || isDeepStrictEqual({ path: pExistingFilter }, pNewFilter)
   );
 }
 
-function filterOptionIsCompatible(pExistingOption, pNewOption) {
+export function filterOptionIsCompatible(pExistingOption, pNewOption) {
   return !pExistingOption || isDeepStrictEqual(pExistingOption, pNewOption);
 }
 
-function optionIsCompatible(pExistingOption, pNewOption) {
+export function optionIsCompatible(pExistingOption, pNewOption) {
   return isDeepStrictEqual(pExistingOption, pNewOption);
 }
 
-function limitIsCompatible(pExistingLimit, pNewLimit) {
+export function limitIsCompatible(pExistingLimit, pNewLimit) {
   return !pExistingLimit || pExistingLimit >= (pNewLimit || pExistingLimit + 1);
 }
 
-function metricsIsCompatible(pExistingMetrics, pNewMetrics) {
+export function metricsIsCompatible(pExistingMetrics, pNewMetrics) {
   return pExistingMetrics || pExistingMetrics === pNewMetrics;
 }
 
-function cacheOptionIsCompatible(pExistingCacheOption, pNewCacheOption) {
+export function cacheOptionIsCompatible(pExistingCacheOption, pNewCacheOption) {
   if (!pExistingCacheOption || !pNewCacheOption) {
     return false;
   }
@@ -92,7 +92,7 @@ function cacheOptionIsCompatible(pExistingCacheOption, pNewCacheOption) {
  * @returns {boolean}
  */
 // eslint-disable-next-line complexity
-function optionsAreCompatible(pOldOptions, pNewOptions) {
+export function optionsAreCompatible(pOldOptions, pNewOptions) {
   return (
     pOldOptions.args === pNewOptions.args &&
     pOldOptions.rulesFile === pNewOptions.rulesFile &&
@@ -131,13 +131,3 @@ function optionsAreCompatible(pOldOptions, pNewOptions) {
     cacheOptionIsCompatible(pOldOptions.cache, pNewOptions.cache)
   );
 }
-
-module.exports = {
-  optionsAreCompatible,
-  filterOptionIsCompatible,
-  optionIsCompatible,
-  limitIsCompatible,
-  metricsIsCompatible,
-  includeOnlyIsCompatible,
-  cacheOptionIsCompatible,
-};

package/src/cli/defaults.mjs

@@ -0,0 +1,17 @@
+export const OLD_DEFAULT_RULES_FILE_NAME = ".dependency-cruiser.json";
+export const RULES_FILE_NAME_SEARCH_ARRAY = [
+  ".dependency-cruiser.json",
+  ".dependency-cruiser.js",
+  ".dependency-cruiser.cjs",
+  ".dependency-cruiser.mjs",
+];
+export const DEFAULT_BASELINE_FILE_NAME =
+  ".dependency-cruiser-known-violations.json";
+export const DEFAULT_CONFIG_FILE_NAME = ".dependency-cruiser.js";
+export const WEBPACK_CONFIG = "webpack.config.js";
+export const TYPESCRIPT_CONFIG = "tsconfig.json";
+export const BABEL_CONFIG = ".babelrc";
+export const PACKAGE_MANIFEST = "package.json";
+export const OUTPUT_TYPE = "err";
+export const OUTPUT_TO = "-";
+export const CACHE_FOLDER = "node_modules/.cache/dependency-cruiser";

package/src/cli/{format-meta-info.js → format-meta-info.mjs}

@@ -1,21 +1,20 @@
-const chalk = require("chalk");
-const figures = require("figures");
-const main = require("../main");
+import chalk from "chalk";
+import figures from "figures";
+
+import { getAvailableTranspilers, allExtensions } from "../main/index.mjs";
 
 function bool2Symbol(pBool) {
   return pBool ? chalk.green(figures.tick) : chalk.red(figures.cross);
 }
 
 function formatTranspilers() {
-  return main
-    .getAvailableTranspilers()
-    .reduce(
-      (pAll, pThis) =>
-        `${pAll}    ${bool2Symbol(pThis.available)} ${pThis.name} (${
-          pThis.version
-        })\n`,
-      `    ${bool2Symbol(true)} javascript (>es1)\n`
-    );
+  return getAvailableTranspilers().reduce(
+    (pAll, pThis) =>
+      `${pAll}    ${bool2Symbol(pThis.available)} ${pThis.name} (${
+        pThis.version
+      })\n`,
+    `    ${bool2Symbol(true)} javascript (>es1)\n`
+  );
 }
 
 function formatExtensions(pExtensions) {
@@ -26,7 +25,7 @@ function formatExtensions(pExtensions) {
   );
 }
 
-module.exports = function formatMetaInfo() {
+export default function formatMetaInfo() {
   return `
   Supported:
 
@@ -41,8 +40,8 @@ module.exports = function formatMetaInfo() {
 ${formatTranspilers()}
   Extensions:
 
-${formatExtensions(main.allExtensions)}
+${formatExtensions(allExtensions)}
 `;
-};
+}
 
 /* eslint security/detect-object-injection : 0 */

package/src/cli/format.mjs

@@ -0,0 +1,26 @@
+import getStream from "get-stream";
+import { format as _format } from "../main/index.mjs";
+import validateFileExistence from "./utl/validate-file-existence.mjs";
+import normalizeOptions from "./normalize-cli-options.mjs";
+import { getInStream, write } from "./utl/io.mjs";
+
+/**
+ *
+ * @param {string} pResultFile the name of the file with cruise results
+ * @param {import("../../types/dependency-cruiser").IFormatOptions} pOptions
+ * @returns {Number} an exitCode
+ */
+export default async function format(pResultFile, pOptions) {
+  const lOptions = await normalizeOptions(pOptions);
+
+  if (pResultFile !== "-") {
+    validateFileExistence(pResultFile);
+  }
+
+  const lResult = await getStream(getInStream(pResultFile));
+
+  const lReportingResult = await _format(JSON.parse(lResult), lOptions);
+
+  write(lOptions.outputTo, lReportingResult.output);
+  return lReportingResult.exitCode;
+}

package/src/cli/{index.js → index.mjs}

@@ -1,33 +1,35 @@
-const path = require("path");
-const glob = require("glob");
-const cloneDeep = require("lodash/cloneDeep");
-const set = require("lodash/set");
-const isInstalledGlobally = require("is-installed-globally");
-const { red, yellow, bold } = require("chalk");
-
-const main = require("../main");
-const bus = require("../utl/bus");
-
-const extractTSConfig = require("../config-utl/extract-ts-config");
-const extractBabelConfig = require("../config-utl/extract-babel-config");
-const extractWebpackResolveConfig = require("../config-utl/extract-webpack-resolve-config");
-const extractKnownViolations = require("../config-utl/extract-known-violations");
-const { INFO } = require("../utl/bus-log-levels");
-const validateFileExistence = require("./utl/validate-file-existence");
-const normalizeCliOptions = require("./normalize-cli-options");
-const io = require("./utl/io");
-const formatMetaInfo = require("./format-meta-info");
-const setUpCliFeedbackListener = require("./listeners/cli-feedback");
-const setUpPerformanceLogListener = require("./listeners/performance-log");
-const setUpNDJSONListener = require("./listeners/ndjson");
-
-function extractResolveOptions(pCruiseOptions) {
+/* eslint-disable import/max-dependencies */
+import { join } from "node:path";
+import { glob } from "glob";
+import cloneDeep from "lodash/cloneDeep.js";
+import set from "lodash/set.js";
+import isInstalledGlobally from "is-installed-globally";
+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 = {};
   const lWebPackConfigFileName =
     pCruiseOptions?.ruleSet?.options?.webpackConfig?.fileName ?? null;
 
   if (lWebPackConfigFileName) {
-    lResolveOptions = extractWebpackResolveConfig(
+    lResolveOptions = await extractWebpackResolveConfig(
       lWebPackConfigFileName,
       pCruiseOptions?.ruleSet?.options?.webpackConfig?.env ?? null,
       pCruiseOptions?.ruleSet?.options?.webpackConfig?.arguments ?? null
@@ -90,21 +92,22 @@ function setUpListener(pCruiseOptions) {
   if (Boolean(lListenerFunction)) {
     lListenerFunction(
       bus,
-      pCruiseOptions?.ruleSet?.options?.progress?.maximumLevel ?? INFO
+      pCruiseOptions?.ruleSet?.options?.progress?.maximumLevel ??
+        busLogLevels.INFO
     );
   }
 }
 
-function runCruise(pFileDirectoryArray, pCruiseOptions) {
+async function runCruise(pFileDirectoryArray, pCruiseOptions) {
   const lCruiseOptions = addKnownViolations(
-    normalizeCliOptions(pCruiseOptions)
+    await normalizeCliOptions(pCruiseOptions)
   );
 
   pFileDirectoryArray
     .filter((pFileOrDirectory) => !glob.hasMagic(pFileOrDirectory))
     .map((pFileOrDirectory) =>
       lCruiseOptions?.ruleSet?.options?.baseDir
-        ? path.join(lCruiseOptions.ruleSet.options.baseDir, pFileOrDirectory)
+        ? join(lCruiseOptions.ruleSet.options.baseDir, pFileOrDirectory)
         : pFileOrDirectory
     )
     .forEach(validateFileExistence);
@@ -112,19 +115,19 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
   setUpListener(lCruiseOptions);
 
   bus.emit("start");
-  const lReportingResult = main.futureCruise(
+  const lReportingResult = await cruise(
     pFileDirectoryArray,
     lCruiseOptions,
-    extractResolveOptions(lCruiseOptions),
+    await extractResolveOptions(lCruiseOptions),
     {
       tsConfig: extractTSConfigOptions(lCruiseOptions),
-      babelConfig: extractBabelConfigOptions(lCruiseOptions),
+      babelConfig: await extractBabelConfigOptions(lCruiseOptions),
     }
   );
 
   bus.emit("progress", "cli: writing results", { complete: 1 });
   bus.emit("write-start");
-  io.write(lCruiseOptions.outputTo, lReportingResult.output);
+  write(lCruiseOptions.outputTo, lReportingResult.output);
 
   return lReportingResult.exitCode;
 }
@@ -135,7 +138,7 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
  * @param {import("../../types/options").ICruiseOptions} lCruiseOptions
  * @returns {number}
  */
-module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
+export default async function executeCli(pFileDirectoryArray, pCruiseOptions) {
   let lCruiseOptions = pCruiseOptions || {};
   let lExitCode = 0;
 
@@ -143,10 +146,10 @@ module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
     /* c8 ignore start */
     if (isInstalledGlobally) {
       process.stderr.write(
-        `\n  ${yellow(
+        `\n  ${chalk.yellow(
           "WARNING"
         )}: You're running a globally installed dependency-cruiser.\n\n` +
-          `           We recommend to ${bold.italic.underline(
+          `           We recommend to ${chalk.bold.italic.underline(
             "install and run it as a local devDependency"
           )} in\n` +
           `           your project instead. There it has your project's environment and\n` +
@@ -158,23 +161,15 @@ module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
     if (lCruiseOptions.info === true) {
       process.stdout.write(formatMetaInfo());
     } else if (lCruiseOptions.init) {
-      // requiring init-config took ~100ms (most of it taken up by requiring
-      // inquirer, measured on a 2.6GHz quad core i7 with flash storage on
-      // macOS 10.15.7). Only requiring it when '--init' is necessary speeds up
-      // (the start-up) of cruises by that same amount. We've since replaced
-      // inquirer with 'prompts' (which is much smaller), but the same reasoning
-      // holds.
-      // eslint-disable-next-line node/global-require, import/max-dependencies
-      const initConfig = require("./init-config");
       initConfig(lCruiseOptions.init);
     } else {
-      lExitCode = runCruise(pFileDirectoryArray, lCruiseOptions);
+      lExitCode = await runCruise(pFileDirectoryArray, lCruiseOptions);
     }
   } catch (pError) {
-    process.stderr.write(`\n  ${red("ERROR")}: ${pError.message}\n`);
+    process.stderr.write(`\n  ${chalk.red("ERROR")}: ${pError.message}\n`);
     bus.emit("end");
     lExitCode = 1;
   }
   bus.emit("end");
   return lExitCode;
-};
+}

package/src/cli/init-config/{build-config.js → build-config.mjs}

@@ -1,9 +1,9 @@
 // @ts-check
-const Handlebars = require("handlebars/runtime");
-const { folderNameArrayToRE } = require("./utl");
+import Handlebars from "handlebars/runtime.js";
+import { folderNameArrayToRE } from "./utl.mjs";
 
 /* eslint import/no-unassigned-import: 0 */
-require("./config.js.template");
+await import("./config.js.template.js");
 
 /**
  * @param {string} pString
@@ -28,12 +28,12 @@ function extensionsToString(pExtensions) {
  * Creates a .dependency-cruiser config with a set of basic validations
  * to the current directory.
  *
- * @param {import("./types").IInitConfig} pNormalizedInitOptions Options that influence the shape of
+ * @param {import("./types.js").IInitConfig} pNormalizedInitOptions Options that influence the shape of
  *                  the configuration
  * @returns {string} the configuration as a string
  */
 
-module.exports = function buildConfig(pNormalizedInitOptions) {
+export default function buildConfig(pNormalizedInitOptions) {
   return Handlebars.templates["config.js.template.hbs"]({
     ...pNormalizedInitOptions,
 
@@ -45,4 +45,4 @@ module.exports = function buildConfig(pNormalizedInitOptions) {
       pNormalizedInitOptions.resolutionExtensions
     ),
   });
-};
+}