dependency-cruiser 16.2.0 → 16.2.1

package/README.md

@@ -42,7 +42,7 @@ a `.dependency-cruiser.js` configuration file attuned to your project[^1][^2].
     `npx`.
 
 [^2]:
-    If you don't don't want to use `npx`, but instead `pnpx` (from the `pnpm`
+    If you don't want to use `npx`, but instead `pnpx` (from the `pnpm`
     package manager) or `yarn` - please refer to that tool's documentation.
     Particularly `pnpx` has semantics that differ from `npx` quite significantly
     and that you want to be aware of before using it. In the mean time: `npx`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "16.2.0",
+  "version": "16.2.1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -16,15 +16,48 @@
     "validation",
     "spelunking"
   ],
-  "author": {
-    "name": "Sander Verweij",
-    "url": "https://sverweij.github.io"
-  },
+  "author": "Sander Verweij (https://sverweij.github.io)",
   "contributors": [
-    {
-      "name": "Klaus Meinhardt",
-      "url": "https://github.com/ajafff"
-    }
+    "Hirotaka Miyagi (https://mh4gf.dev)",
+    "TruongSinh Tran-Nguyen (https://truongsinh.pro)",
+    "Bastian Hess (https://github.com/bashess)",
+    "Álvaro Cuesta (https://github.com/alvaro-cuesta)",
+    "anna (https://github.com/annamooseity)",
+    "Radosław Kłos (https://klos.dev)",
+    "Joshua T (https://github.com/radiantly)",
+    "Ivan (https://github.com/Winner95)",
+    "Frieder Bluemle (https://github.com/friederbluemle)",
+    "davidparkagoda (https://github.com/davidparkagoda)",
+    "Matt Button (https://github.com/BRMatt)",
+    "Jon Lauridsen (https://jonlauridsen.com)",
+    "Klaus Meinhardt (https://github.com/ajafff)",
+    "cunzaizhuyi (https://github.com/cunzaizhuyi)",
+    "Greg Lockwood (https://github.com/greglockwood)",
+    "Jeremy Magland (https://github.com/magland)",
+    "Sebastian Landwehr (https://sebastianlandwehr.com)",
+    "Brody McKee (https://github.com/mrmckeb)",
+    "Bin (https://github.com/soulhat)",
+    "정건우 (https://www.zigae.com/)",
+    "Roy Swinkels (https://github.com/donroyco)",
+    "Martin Slota (https://github.com/martinslota)",
+    "Luke Page (https://github.com/lukeapage)",
+    "Emily Marigold Klassen (https://forivall.com)",
+    "Christian Vuerings (https://github.com/christianvuerings)",
+    "Yuanhai He (https://bestmike007.com)",
+    "Quentin de Metz (https://github.com/quentindemetz)",
+    "Lars Artmann (https://larsartmann.com)",
+    "Jessica Kerr (https://jessitron.com)",
+    "Creative Ataraxia (https://github.com/Creative-Ataraxia)",
+    "0xflotus (https://github.com/0xflotus)",
+    "Daniel Edholm Ignat (https://github.com/dignite)",
+    "Daniel Rodríguez Rivero (https://danielorodriguez.com)",
+    "Nick Ribal (https://github.com/elektronik2k5)",
+    "Richard Musiol https(://github.com/neelance)",
+    "Sharang Pai (https://sharangpai.me)",
+    "Stefan Gojan (https://stefan-gojan.de)",
+    "Tharun Rajendran (https://github.com/tharun208)",
+    "electrovir (https://github.com/electrovir)",
+    "fusheng (https://github.com/lin-hun)"
   ],
   "license": "MIT",
   "repository": {
@@ -115,11 +148,11 @@
     "is-installed-globally": "1.0.0",
     "json5": "2.2.3",
     "lodash": "4.17.21",
-    "picomatch": "3.0.1",
+    "picomatch": "4.0.1",
     "prompts": "2.4.2",
     "rechoir": "^0.8.0",
     "safe-regex": "2.1.1",
-    "semver": "^7.5.4",
+    "semver": "^7.6.0",
     "semver-try-require": "6.2.3",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.1.0",
@@ -127,11 +160,11 @@
     "wrap-ansi": "9.0.0"
   },
   "overrides": {
-    "semver": "^7.5.4",
+    "semver": "^7.6.0",
     "postcss": "^8.4.31"
   },
   "resolutions": {
-    "semver": "^7.5.4",
+    "semver": "^7.6.0",
     "postcss": "^8.4.31"
   },
   "engines": {

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

@@ -199,38 +199,31 @@ module.exports = {
   ],
   options: {
 
-    /* conditions specifying which files not to follow further when encountered:
-       - path: a regular expression to match
-       - dependencyTypes: see https://github.com/sverweij/dependency-cruiser/blob/main/doc/rules-reference.md#dependencytypes-and-dependencytypesnot
-       for a complete list
-    */
+    /* Which modules not to follow further when encountered */
     doNotFollow: {
-      path: 'node_modules'
+      /* path: an array of regular expressions in strings to match against */
+      path: ['node_modules']
     },
 
-    /* conditions specifying which dependencies to exclude
-       - path: a regular expression to match
-       - dynamic: a boolean indicating whether to ignore dynamic (true) or static (false) dependencies.
-          leave out if you want to exclude neither (recommended!)
-    */
+    /* Which modules to exclude */
     // exclude : {
+    //   /* path: an array of regular expressions in strings to match against */
     //   path: '',
-    //   dynamic: true
     // },
 
-    /* pattern specifying which files to include (regular expression)
+    /* Which modules to exclusively include (array of regular expressions in strings)
        dependency-cruiser will skip everything not matching this pattern
     */
-    // includeOnly : '',
+    // includeOnly : [''],
 
     /* dependency-cruiser will include modules matching against the focus
-       regular expression in its output, as well as their neighbours (direct
-       dependencies and dependents)
+       regular expression in its output, as well as their direct neighbours 
+       (dependencies and dependents)
     */
     // focus : '',
 
-    /* List of module systems to cruise. 
-       When left out dependency-cruiser will fall back to the list of _all_ 
+    /* List of module systems to cruise.
+       When left out dependency-cruiser will fall back to the list of _all_
        module systems it knows of. It's the default because it's the safe option
        It might come at a performance penalty, though.
        moduleSystems: ['amd', 'cjs', 'es6', 'tsd']
@@ -245,7 +238,7 @@ module.exports = {
        to open it on your online repo or \`vscode://file/$\{process.cwd()}/\` to 
        open it in visual studio code),
      */
-    // prefix: '',
+    // prefix: 'vscode://file/$\{process.cwd()}/\',
 
     /* false (the default): ignore dependencies that only exist before typescript-to-javascript compilation
        true: also detect dependencies that only exist before typescript-to-javascript compilation
@@ -253,10 +246,9 @@ module.exports = {
      */
     {{tsPreCompilationDepsAttribute}}
     
-    /* 
-       list of extensions to scan that aren't javascript or compile-to-javascript. 
+    /* list of extensions to scan that aren't javascript or compile-to-javascript.
        Empty by default. Only put extensions in here that you want to take into
-       account that are _not_ parsable. 
+       account that are _not_ parsable.
     */
     // extraExtensionsToScan: [".json", ".jpg", ".png", ".svg", ".webp"],
 
@@ -293,9 +285,7 @@ module.exports = {
 
     /* Babel config ('.babelrc', '.babelrc.json', '.babelrc.json5', ...) to use
       for compilation (and whatever other naughty things babel plugins do to
-      source code). This feature is well tested and usable, but might change
-      behavior a bit over time (e.g. more precise results for used module 
-      systems) without dependency-cruiser getting a major version bump.
+      source code).
      */
     {{babelConfigAttribute}}
 
@@ -305,57 +295,37 @@ module.exports = {
        a hack.
     */
     // exoticRequireStrings: [],
+    
     /* options to pass on to enhanced-resolve, the package dependency-cruiser
-       uses to resolve module references to disk. You can set most of these
-       options in a webpack.conf.js - this section is here for those
-       projects that don't have a separate webpack config file.
+       uses to resolve module references to disk. The values below should be
+       suitable for most situations
 
-       Note: settings in webpack.conf.js override the ones specified here.
+       If you use webpack: you can also set these in webpack.conf.js. The set
+       there will override the ones specified here.
      */
     enhancedResolveOptions: {
-      /* List of strings to consider as 'exports' fields in package.json. Use
-         ['exports'] when you use packages that use such a field and your environment
-         supports it (e.g. node ^12.19 || >=14.7 or recent versions of webpack).
-
-         If you have an \`exportsFields\` attribute in your webpack config, that one
-         will have precedence over the one specified here.
-      */ 
+      /* What to consider as an 'exports' field in package.jsons */ 
       exportsFields: ["exports"],
-      /* List of conditions to check for in the exports field. e.g. use ['imports']
-         if you're only interested in exposed es6 modules, ['require'] for commonjs,
-         or all conditions at once \`(['import', 'require', 'node', 'default']\`)
-         if anything goes for you. Only works when the 'exportsFields' array is
-         non-empty.
-
-        If you have a 'conditionNames' attribute in your webpack config, that one will
-        have precedence over the one specified here.
+      /* List of conditions to check for in the exports field.
+         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
          can access (run \`npx depcruise --info\` to see which ones that are in
-         _your_ environment. If that list is larger than what you need (e.g. 
-         it contains .js, .jsx, .ts, .tsx, .cts, .mts - but you don't use 
-         TypeScript you can pass just the extensions you actually use (e.g. 
-         [".js", ".jsx"]). This can speed up the most expensive step in 
-         dependency cruising (module resolution) quite a bit.
+         _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
+         up the most expensive step in dependency cruising (module resolution)
+          quite a bit.
        */
       {{extensionsAttribute}}
-      /* 
-         If your TypeScript project makes use of types specified in 'types'
-         fields in package.jsons of external dependencies, specify "types"
-         in addition to "main" in here, so enhanced-resolve (the resolver
-         dependency-cruiser uses) knows to also look there. You can also do
-         this if you're not sure, but still use TypeScript. In a future version
-         of dependency-cruiser this will likely become the default.
-       */
+      /* What to consider a 'main' field in package.json */
       {{mainFieldsAttribute}}
       /*
-         A list of alias fields in manifests (package.jsons).
-         Specify a field, such as browser, to be parsed according to
-         [this specification](https://github.com/defunctzombie/package-browser-field-spec).
-         Also see [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealiasfields)
-         in the webpack docs. 
+         A list of alias fields in package.jsons
+         See [this specification](https://github.com/defunctzombie/package-browser-field-spec) and
+         the [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealiasfields)
+         documentation in the webpack docs. 
          
          Defaults to an empty array (don't use any alias fields).
        */
@@ -377,70 +347,13 @@ module.exports = {
         */
         // theme: {
         //   graph: {
-        //     /* use splines: "ortho" for straight lines. Be aware though
-        //       graphviz might take a long time calculating ortho(gonal)
-        //       routings.
+        //     /* splines: "ortho" will give you straight lines at the expense of
+        //                 being slow to render on big graphs
+        //        splines: "true" will give you bezier curves which are faster
+        //                 but might not look as nice
         //    */
         //     splines: "true"
         //   },
-        //   modules: [
-        //     {
-        //       criteria: { matchesFocus: true },
-        //       attributes: {
-        //         fillcolor: "lime",
-        //         penwidth: 2,
-        //       },
-        //     },
-        //     {
-        //       criteria: { matchesFocus: false },
-        //       attributes: {
-        //         fillcolor: "lightgrey",
-        //       },
-        //     },
-        //     {
-        //       criteria: { matchesReaches: true },
-        //       attributes: {
-        //         fillcolor: "lime",
-        //         penwidth: 2,
-        //       },
-        //     },
-        //     {
-        //       criteria: { matchesReaches: false },
-        //       attributes: {
-        //         fillcolor: "lightgrey",
-        //       },
-        //     },
-        //     {
-        //       criteria: { source: "^src/model" },
-        //       attributes: { fillcolor: "#ccccff" }
-        //     },
-        //     {
-        //       criteria: { source: "^src/view" },
-        //       attributes: { fillcolor: "#ccffcc" }
-        //     },
-        //   ],
-        //   dependencies: [
-        //     {
-        //       criteria: { "rules[0].severity": "error" },
-        //       attributes: { fontcolor: "red", color: "red" }
-        //     },
-        //     {
-        //       criteria: { "rules[0].severity": "warn" },
-        //       attributes: { fontcolor: "orange", color: "orange" }
-        //     },
-        //     {
-        //       criteria: { "rules[0].severity": "info" },
-        //       attributes: { fontcolor: "blue", color: "blue" }
-        //     },
-        //     {
-        //       criteria: { resolved: "^src/model" },
-        //       attributes: { color: "#0000ff77" }
-        //     },
-        //     {
-        //       criteria: { resolved: "^src/view" },
-        //       attributes: { color: "#00770077" }
-        //     }
-        //   ]
         // }
       },
       archi: {
@@ -455,7 +368,7 @@ module.exports = {
            https://github.com/sverweij/dependency-cruiser/blob/main/doc/options-reference.md#reporteroptions
            for details and some examples. If you don't specify a theme
            for 'archi' dependency-cruiser will use the one specified in the
-           dot section (see above), if any, and otherwise use the default one.
+           dot section above and otherwise use the default one.
          */
         // theme: {
         // },

package/src/cli/init-config/write-run-scripts-to-manifest.mjs

@@ -102,7 +102,7 @@ export function addRunScriptsToManifest(pManifest, pAdditionalRunScripts) {
   const lManifest = { ...(pManifest || {}) };
   const lExistingRunScripts = lManifest.scripts || {};
 
-  // This could instead simply be done with
+  // This could instead be done with
   // {...pAdditionalScriptEntries, ...lManifest} and no logic at all,
   // but that'd add the new scripts on top, which doesn't feel right
   //

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

@@ -37,8 +37,9 @@ async function processExtends(pReturnValue, pAlreadyVisited, pBaseDirectory) {
  * Reads the file with name `pConfigFileName` returns the parsed cruise
  * options.
  *
- * You can safely ignore the optional parameters. Simply this should work (given
- * `.dependency-cruiser.js` exists and contains a valid dependency-cruiser config)
+ * 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")

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

@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */
 import { isAbsolute, resolve as path_resolve } from "node:path";
 import { join as posix_join } from "node:path/posix";
-import { isMatch } from "picomatch";
+import picomatch from "picomatch";
 import getExtension from "#utl/get-extension.mjs";
 
 let gFollowableExtensionsCache = new Set();
@@ -158,7 +158,7 @@ function isWorkspaceAliased(pModuleName, pResolvedModuleName, pManifest) {
       (pWorkspace) =>
         pWorkspace.endsWith("/") ? `${pWorkspace}**` : `${pWorkspace}/**`,
     );
-    if (isMatch(pResolvedModuleName, lModuleFriendlyWorkspaceGlobs)) {
+    if (picomatch.isMatch(pResolvedModuleName, lModuleFriendlyWorkspaceGlobs)) {
       return true;
     }
     // it's possible to run node with --preserve-symlinks, in which case
@@ -176,7 +176,10 @@ function isWorkspaceAliased(pModuleName, pResolvedModuleName, pManifest) {
       lModuleFriendlyWorkspaceGlobs.map(
         (pWorkspace) => `(node_modules/)?${pWorkspace}`,
       );
-    return isMatch(pModuleName, lModuleFriendlyWorkspaceGlobsWithNodeModules);
+    return picomatch.isMatch(
+      pModuleName,
+      lModuleFriendlyWorkspaceGlobsWithNodeModules,
+    );
   }
   return false;
 }

package/src/meta.js

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

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

@@ -4,8 +4,9 @@ import type { ICruiseOptions } from "../options.mjs";
  * Reads the file with name `pConfigFileName` returns the parsed cruise
  * options.
  *
- * You can safely ignore the optional parameters. Simply this should work (given
- * `.dependency-cruiser.js` exists and contains a valid dependency-cruiser config)
+ * 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")