dependency-cruiser 16.3.0 → 16.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "16.3.0",
+  "version": "16.3.2",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -95,6 +95,10 @@
       "types": "./types/config-utl/extract-depcruise-config.d.mts",
       "import": "./src/config-utl/extract-depcruise-config/index.mjs"
     },
+    "./config-utl/extract-depcruise-options": {
+      "types": "./types/config-utl/extract-depcruise-options.d.mts",
+      "import": "./src/config-utl/extract-depcruise-options.mjs"
+    },
     "./config-utl/extract-ts-config": {
       "types": "./types/config-utl/extract-ts-config.d.mts",
       "import": "./src/config-utl/extract-ts-config.mjs"
@@ -136,10 +140,10 @@
     "acorn-jsx-walk": "2.0.0",
     "acorn-loose": "8.4.0",
     "acorn-walk": "8.3.2",
-    "ajv": "8.12.0",
+    "ajv": "8.13.0",
     "chalk": "5.3.0",
     "commander": "12.0.0",
-    "enhanced-resolve": "5.16.0",
+    "enhanced-resolve": "5.16.1",
     "figures": "6.1.0",
     "ignore": "5.3.1",
     "indent-string": "5.0.0",
@@ -152,19 +156,19 @@
     "prompts": "2.4.2",
     "rechoir": "^0.8.0",
     "safe-regex": "2.1.1",
-    "semver": "^7.6.0",
-    "semver-try-require": "6.2.3",
+    "semver": "^7.6.1",
+    "semver-try-require": "7.0.0",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.1.0",
-    "watskeburt": "4.0.1",
+    "watskeburt": "4.0.2",
     "wrap-ansi": "9.0.0"
   },
   "overrides": {
-    "semver": "^7.6.0",
+    "semver": "^7.6.1",
     "postcss": "^8.4.31"
   },
   "resolutions": {
-    "semver": "^7.6.0",
+    "semver": "^7.6.1",
     "postcss": "^8.4.31"
   },
   "engines": {

package/src/config-utl/extract-depcruise-config/index.mjs

@@ -47,7 +47,7 @@ async function processExtends(pReturnValue, pAlreadyVisited, pBaseDirectory) {
  * @param {string} pConfigFileName
  * @param {Set?} pAlreadyVisited
  * @param {string?} pBaseDirectory
- * @return {import('../../../types/options.mjs').ICruiseOptions} dependency-cruiser options
+ * @return {import('../../../types/configuration.mjs').IConfiguration} dependency-cruiser options
  * @throws {Error} when the config is not valid (/ does not exist/ isn't readable)
  */
 export default async function extractDepcruiseConfig(

package/src/config-utl/extract-depcruise-config/read-config.mjs

@@ -2,6 +2,11 @@ import { readFile } from "node:fs/promises";
 import { extname } from "node:path";
 import json5 from "json5";
 
+/**
+ *
+ * @param {string} pAbsolutePathToConfigFile
+ * @returns {Promise<import('../../../types/configuration.mjs').IConfiguration>}
+ */
 export default async function readConfig(pAbsolutePathToConfigFile) {
   if (
     [".js", ".cjs", ".mjs", ""].includes(extname(pAbsolutePathToConfigFile))

package/src/config-utl/extract-depcruise-options.mjs

@@ -0,0 +1,28 @@
+import extractDepcruiseConfig from "./extract-depcruise-config/index.mjs";
+
+/**
+ *
+ * @param {import('../../../types/configuration.mjs').IConfiguration}} pConfiguration
+ * @returns {import('../../../types/configuration.mjs').ICruiseOptions}
+ */
+function configuration2options(pConfiguration) {
+  /* c8 ignore next 1 */
+  const lConfiguration = structuredClone(pConfiguration || {});
+  const lReturnValue = structuredClone(lConfiguration?.options ?? {});
+
+  delete lConfiguration.options;
+  lReturnValue.ruleSet = structuredClone(lConfiguration);
+  lReturnValue.validate = Object.keys(lReturnValue.ruleSet).length > 0;
+
+  return lReturnValue;
+}
+
+/**
+ *
+ * @param {string} pConfigFileName
+ * @returns {Promise<import('../../../types/configuration.mjs').ICruiseOptions>}
+ */
+export default async function extractDepcruiseOptions(pConfigFileName) {
+  const lReturnValue = await extractDepcruiseConfig(pConfigFileName);
+  return configuration2options(lReturnValue);
+}

package/src/extract/helpers.mjs

@@ -28,8 +28,6 @@ export function detectPreCompilationNess(pTSDependencies, pJSDependencies) {
   );
 }
 
-/* eslint-disable security/detect-object-injection */
-
 /**
  * Given a module string returns in an object
  * - the module name
@@ -42,25 +40,22 @@ export function detectPreCompilationNess(pTSDependencies, pJSDependencies) {
  * (if there's a default node API that does this I'm all ears)
  *
  * @param {string} pString
- * @returns {any}
+ * @returns {{module:string; protocol?:string; mimeType?:string}}
  */
 export function extractModuleAttributes(pString) {
   let lReturnValue = { module: pString };
   const lModuleAttributes = pString.match(
     // eslint-disable-next-line security/detect-unsafe-regex
-    /^((node:|file:|data:)(([^,]+),)?)(.+)$/,
+    /^(?:(?<protocol>node:|file:|data:)(?:(?<mimeType>[^,]+),)?)(?<module>.+)$/,
   );
-  const lProtocolPosition = 2;
-  const lMimeTypePosition = 4;
-  const lModulePosition = 5;
 
-  if (lModuleAttributes) {
-    lReturnValue.module = lModuleAttributes[lModulePosition];
-    if (lModuleAttributes[lProtocolPosition]) {
-      lReturnValue.protocol = lModuleAttributes[lProtocolPosition];
+  if (lModuleAttributes?.groups) {
+    lReturnValue.module = lModuleAttributes?.groups.module;
+    if (lModuleAttributes?.groups?.protocol) {
+      lReturnValue.protocol = lModuleAttributes.groups.protocol;
     }
-    if (lModuleAttributes[lMimeTypePosition]) {
-      lReturnValue.mimeType = lModuleAttributes[lMimeTypePosition];
+    if (lModuleAttributes?.groups?.mimeType) {
+      lReturnValue.mimeType = lModuleAttributes.groups.mimeType;
     }
   }
 

package/src/extract/resolve/module-classifiers.mjs

@@ -106,7 +106,7 @@ function isSubpathImport(pModuleName, pManifest) {
       const lMatchREasString = pImportLHS.replace(/\*/g, ".+");
       // eslint-disable-next-line security/detect-non-literal-regexp
       const lMatchRE = new RegExp(`^${lMatchREasString}$`);
-      return Boolean(pModuleName.match(lMatchRE));
+      return lMatchRE.test(pModuleName);
     })
   );
 }
@@ -217,7 +217,7 @@ function matchesTSConfigPaths(pModuleName, pPaths) {
   return Object.keys(pPaths).some((pPathLHS) => {
     // eslint-disable-next-line security/detect-non-literal-regexp
     const lMatchRE = new RegExp(`^${pPathLHS.replace(/\*/g, ".+")}$`);
-    return Boolean(pModuleName.match(lMatchRE));
+    return lMatchRE.test(pModuleName);
   });
 }
 

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

@@ -5,7 +5,7 @@ import { coerce, satisfies } from "semver";
 const require = createRequire(import.meta.url);
 
 const PACKAGE_RE = "[^/]+";
-const SCOPED_PACKAGE_RE = "@[^/]+(/[^/]+)";
+const SCOPED_PACKAGE_RE = "@[^/]+(?:/[^/]+)";
 const ROOT_MODULE_RE = new RegExp(`^(${SCOPED_PACKAGE_RE}|${PACKAGE_RE})`, "g");
 
 function extractRootModuleName(pModuleName) {
@@ -17,10 +17,9 @@ function getVersion(pModuleName) {
   // (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"
-  ));
+  const lManifest = require(
+    path.join(extractRootModuleName(pModuleName), "package.json"),
+  );
   return lManifest.version;
 }
 

package/src/graph-utl/rule-set.mjs

@@ -10,9 +10,10 @@
  * @return {import("../../types/rule-set").IForbiddenRuleType|undefined} - a rule (or 'undefined' if nothing found)
  */
 export function findRuleByName(pRuleSet, pName) {
-  return (pRuleSet?.forbidden ?? []).find(
-    (pForbiddenRule) => pForbiddenRule.name === pName,
+  const lNamedRules = (pRuleSet?.forbidden ?? []).concat(
+    pRuleSet?.required ?? [],
   );
+  return lNamedRules.find((pRule) => pRule.name === pName);
 }
 
 function ruleHasALicenseLikeAttribute(pRule) {

package/src/main/options/assert-validity.mjs

@@ -2,7 +2,7 @@ import merge from "lodash/merge.js";
 import safeRegex from "safe-regex";
 import report from "#report/index.mjs";
 
-const MODULE_SYSTEM_LIST_RE = /^((cjs|amd|es6|tsd)(,|$))+$/gi;
+const MODULE_SYSTEM_LIST_RE = /^(?:(?:cjs|amd|es6|tsd)(?:,|$)){1,4}/gi;
 const VALID_DEPTH_RE = /^\d{1,2}$/g;
 
 function assertModuleSystemsValid(pModuleSystems) {

package/src/main/rule-set/normalize.mjs

@@ -1,6 +1,6 @@
 import { normalizeREProperties, normalizeToREAsString } from "../helpers.mjs";
 
-const VALID_SEVERITIES = /^(error|warn|info|ignore)$/;
+const VALID_SEVERITIES = /^(?:error|warn|info|ignore)$/;
 const DEFAULT_SEVERITY = "warn";
 const DEFAULT_RULE = "unnamed";
 const DEFAULT_SCOPE = "module";
@@ -8,9 +8,7 @@ const DEFAULT_SCOPE = "module";
 function normalizeSeverity(pSeverity) {
   const lSeverity = pSeverity ? pSeverity : DEFAULT_SEVERITY;
 
-  return Boolean(lSeverity.match(VALID_SEVERITIES))
-    ? lSeverity
-    : DEFAULT_SEVERITY;
+  return VALID_SEVERITIES.test(lSeverity) ? lSeverity : DEFAULT_SEVERITY;
 }
 /**
  *

package/src/meta.cjs

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

package/src/report/anon/anonymize-path.mjs

@@ -2,7 +2,7 @@ import { anonymizePathElement } from "./anonymize-path-element.mjs";
 
 export const WHITELIST_RE =
   // eslint-disable-next-line security/detect-unsafe-regex
-  /^(|[.]+|~|bin|apps?|cli|src|libs?|configs?|components?|fixtures?|helpers?|i18n|index\.(jsx?|[mc]js|d\.ts|tsx?|vue|coffee|ls)|_?_?mocks?_?_?|node_modules|packages?|package\.json|scripts?|services?|sources?|specs?|_?_?tests?_?_?|types?|uti?ls?|tools)$/;
+  /^(?:|[.]+|~|bin|apps?|cli|src|libs?|configs?|components?|fixtures?|helpers?|i18n|index\.(?:jsx?|[mc]js|d\.ts|tsx?|vue|coffee|ls)|_?_?mocks?_?_?|node_modules|packages?|package\.json|scripts?|services?|sources?|specs?|_?_?tests?_?_?|types?|uti?ls?|tools)$/;
 
 /**
  * Kind of smartly anonymizes paths, by

package/src/report/utl/index.mjs

@@ -33,7 +33,7 @@ export function formatViolation(
  * @return {string} prefix and filename concatenated
  */
 function smartURIConcat(pPrefix, pSource) {
-  if (pPrefix.match(PROTOCOL_PREFIX_RE)) {
+  if (PROTOCOL_PREFIX_RE.test(pPrefix)) {
     return `${pPrefix}${pSource}`;
   } else {
     return join(pPrefix, pSource);

package/src/utl/get-extension.mjs

@@ -1,7 +1,7 @@
 // @ts-check
 import { extname } from "node:path";
 
-const EXTENSION_RE = /(?<extension>((\.d\.(c|m)?ts)|\.coffee\.md)$)/;
+const EXTENSION_RE = /(?<extension>(?:(?:\.d\.(?:c|m)?ts)|\.coffee\.md)$)/;
 
 /**
  * Returns the extension of the given file name path.

package/types/config-utl/extract-depcruise-config.d.mts

@@ -1,25 +1,27 @@
-import type { ICruiseOptions } from "../options.mjs";
+import type { IConfiguration } from "../configuration.mjs";
 
 /**
  * Reads the file with name `pConfigFileName` returns the parsed cruise
- * options.
+ * configuration. If you're  looking for the function to read a
+ * dependency-cruiser configuration file and put the result into the `cruise`
+ * function use `extractDepcruiseOptions` instead.s
  *
  * You can safely ignore the optional parameters. This should work (given
  * `.dependency-cruiser.js` exists and contains a valid dependency-cruiser
  * config)
  *
  * ```javascript
- * const depcruiseConfig = extractDepcruiseConfig("./.dependency-cruiser.js")
+ * const depcruiseConfig = await extractDepcruiseConfig("./.dependency-cruiser.js")
  * ```
  *
  * @param pConfigFileName
  * @param pAlreadyVisited
  * @param pBaseDirectory
- * @return dependency-cruiser options
+ * @return dependency-cruiser configuration
  * @throws when the config is not valid (/ does not exist/ isn't readable)
  */
 export default function extractDepcruiseConfig(
   pConfigFileName: string,
   pAlreadyVisited?: Set<string>,
-  pBaseDirectory?: string
-): Promise<ICruiseOptions>;
+  pBaseDirectory?: string,
+): Promise<IConfiguration>;

package/types/config-utl/extract-depcruise-options.d.mts

@@ -0,0 +1,18 @@
+import type { ICruiseOptions } from "../options.mjs";
+
+/**
+ * Reads the file with name `pConfigFileName` returns the parsed cruise
+ * options you can use as
+ *
+ * ```javascript
+ * const depcruiseOptions = await extractDepcruiseOptions("./.dependency-cruiser.js")
+ * const cruiseResult = await cruise(["./src"], depcruiseOptions);
+ * ```
+ *
+ * @param pConfigFileName
+ * @return dependency-cruiser options
+ * @throws when the config is not valid (/ does not exist/ isn't readable)
+ */
+export default function extractDepcruiseOptions(
+  pConfigFileName: string,
+): Promise<ICruiseOptions>;

package/types/dependency-cruiser.d.mts

@@ -90,7 +90,7 @@ export interface ITranspileOptions {
 export function cruise(
   pFileAndDirectoryArray: string[],
   pCruiseOptions?: ICruiseOptions,
-  pResolveOptions?: IResolveOptions,
+  pResolveOptions?: Partial<IResolveOptions>,
   pTranspileOptions?: ITranspileOptions,
 ): Promise<IReporterOutput>;