dependency-cruiser 12.1.1 → 12.3.0-beta-1

package/README.md

@@ -154,7 +154,7 @@ You've come to the right place :-) :
 
 ## Build status
 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/sverweij/dependency-cruiser/linting%20%26%20test%20coverage%20-%20linux?label=actions&logo=github)](https://github.com/sverweij/dependency-cruiser/actions)
+[![GitHub Workflow Status](https://github.com/sverweij/dependency-cruiser/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/sverweij/dependency-cruiser/actions/workflows/ci.yml)
 [![coverage](https://gitlab.com/sverweij/dependency-cruiser/badges/master/coverage.svg)](https://gitlab.com/sverweij/dependency-cruiser/builds)
 [![Maintainability](https://api.codeclimate.com/v1/badges/93035ef5fba33901d479/maintainability)](https://codeclimate.com/github/sverweij/dependency-cruiser/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/93035ef5fba33901d479/test_coverage)](https://codeclimate.com/github/sverweij/dependency-cruiser/test_coverage)

package/configs/plugins/3d-reporter-plugin.js

@@ -81,7 +81,7 @@ function formatDependency(pFrom, pTo) {
 
 /**
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult
+ * @param {import('../..').ICruiseResult} pCruiseResult
  */
 function render3DThing(pCruiseResult) {
   const lNodes = pCruiseResult.modules.map((pModule) => {
@@ -114,10 +114,10 @@ function render3DThing(pCruiseResult) {
 /**
  * Sample plugin: 3d representation
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
+ * @param {import('../..').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @return {import('../..').IReporterOutput} -
  *      output: a string
  *      exitCode: 0
  */

package/configs/plugins/stats-reporter-plugin.js

@@ -33,7 +33,7 @@ function doMagic(pCruiseResult) {
  * returns an object with some stats from the ICruiseResult pCruiseResult it
  * got passed
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult - a result from a cruise.
+ * @param {import('../..').ICruiseResult} pCruiseResult - a result from a cruise.
  * @return {string} an object with some stats
  */
 function samplePluginReporter(pCruiseResult) {
@@ -65,10 +65,10 @@ function samplePluginReporter(pCruiseResult) {
 /**
  * Sample plugin
  *
- * @param {import('../../types/dependency-cruiser').ICruiseResult} pCruiseResult -
+ * @param {import('../..').ICruiseResult} pCruiseResult -
  *      the output of a dependency-cruise adhering to dependency-cruiser's
  *      cruise result schema
- * @return {import('../../types/dependency-cruiser').IReporterOutput} -
+ * @return {import('../..').IReporterOutput} -
  *      output: some stats on modules and dependencies in json format
  *      exitCode: 0
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "12.1.1",
+  "version": "12.3.0-beta-1",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -87,12 +87,14 @@
     "depcruise:graph:doc:samples": "sh tools/generate-samples.sh",
     "depcruise:graph:dot": "node ./bin/dependency-cruise.js bin src --config --output-type dot | dot -T svg > tmp_deps.svg",
     "depcruise:graph:fdp": "node ./bin/dependency-cruise.js bin src --config --output-type dot | fdp -GK=0.1 -Gsplines=true -T svg > tmp_deps.svg",
+    "depcruise:graph:mermaid": "node ./bin/dependency-cruise.js bin src --include-only ^src/ --config --collapse 2 --output-type mermaid",
+    "depcruise:graph:mermaid:diff": "node ./bin/dependency-cruise.js bin src test types tools --config configs/.dependency-cruiser-unlimited.json --output-type mermaid --reaches \"$(watskeburt $SHA)\"",
     "depcruise:graph:osage": "node ./bin/dependency-cruise.js bin src --config --output-type dot | osage -Gpack=32 -GpackMode=array2 -T svg > tmp_deps.svg",
     "depcruise:graph:view": "node ./bin/dependency-cruise.js bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.json --output-type dot --progress cli-feedback --highlight \"$(watskeburt develop)\" | dot -T svg | node ./bin/wrap-stream-in-html.js | browser",
     "depcruise:graph:view:diff": "node ./bin/dependency-cruise.js 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.js | browser",
     "depcruise:report": "node ./bin/dependency-cruise.js src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.json --output-to dependency-violations.html",
     "depcruise:report:view": "node ./bin/dependency-cruise.js src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.json --output-to - | browser",
-    "depcruise:focus": "node ./bin/dependency-cruise.js src bin test configs types tools --progress --config configs/.dependency-cruiser-show-metrics-config.json --output-type text --focus",
+    "depcruise:focus": "node ./bin/dependency-cruise.js src bin test configs types tools --progress --config --output-type text --focus",
     "depcruise:reaches": "node ./bin/dependency-cruise.js src bin test configs types tools --progress --config configs/.dependency-cruiser-unlimited.json --output-type text --reaches",
     "format": "prettier --loglevel warn --write \"src/**/*.js\" \"configs/**/*.js\" \"tools/**/*.mjs\" \"bin/*\" \"types/*.d.ts\" \"test/**/*.spec.{cjs,js}\" \"test/**/*.{spec,utl}.mjs\"",
     "format:check": "prettier --loglevel warn --check \"src/**/*.js\" \"configs/**/*.js\" \"tools/**/*.mjs\" \"bin/*\" \"types/*.d.ts\" \"test/**/*.spec.{cjs,js}\" \"test/**/*.{spec,utl}.mjs\"",
@@ -116,11 +118,11 @@
     "scm:push:gitlab-mirror:commits": "git push gitlab-mirror",
     "scm:push:gitlab-mirror:tags": "git push --tags gitlab-mirror",
     "scm:stage": "git add .",
-    "test": "mocha",
-    "test:i": "mocha --grep \"^\\[[I]\\]\"",
-    "test:u": "mocha --grep \"^\\[[U]\\]\"",
-    "test:e": "mocha --grep \"^\\[[E]\\]\"",
-    "test:cover": "c8 --check-coverage --statements 99.9 --branches 99.7 --functions 100 --lines 99.9 --exclude \"{bin,configs/*.js,configs/rules,configs/plugins/3d-*.js,configs/plugins/stats-*.js,doc,docs,coverage,test,tools,webpack.conf.js,tmp*,src/**/*.template.js,src/cli/tools/svg-in-html-snippets/script.snippet.js,src/cli/init-config/get-user-input.js,src/cli/listeners/*/index.js}\" --reporter text-summary --reporter html --reporter json-summary mocha",
+    "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 --check-coverage --statements 99.9 --branches 99.7 --functions 100 --lines 99.9 --exclude \"{bin,configs/*.js,configs/rules,configs/plugins/3d-*.js,configs/plugins/stats-*.js,doc,docs,coverage,test,tools,webpack.conf.js,tmp*,src/**/*.template.js,src/cli/tools/svg-in-html-snippets/script.snippet.js,src/cli/init-config/get-user-input.js,src/cli/listeners/*/index.js}\" --reporter text-summary --reporter html --reporter json-summary mocha",
     "test:glob": "set -f && test \"`bin/dependency-cruise.js test/extract/__mocks__/gather-globbing/packages/**/src/**/*.js | grep \"no dependency violations found\"`\" = \"✔ no dependency violations found (6 modules, 0 dependencies cruised)\"",
     "test:yarn-pnp": "npm-run-all test:yarn-pnp:cleanup test:yarn-pnp:pack test:yarn-pnp:copy test:yarn-pnp:install test:yarn-pnp:version test:yarn-pnp:run test:yarn-pnp:test test:yarn-pnp:cleanup",
     "test:yarn-pnp:pack": "npm pack",
@@ -154,7 +156,7 @@
     "glob": "7.2.0",
     "handlebars": "4.7.7",
     "indent-string": "^4.0.0",
-    "interpret": "^2.2.0",
+    "interpret": "^3.1.0",
     "is-installed-globally": "0.4.0",
     "json5": "2.2.2",
     "lodash": "4.17.21",
@@ -169,15 +171,15 @@
     "wrap-ansi": "^7.0.0"
   },
   "devDependencies": {
-    "@babel/core": "7.20.5",
-    "@babel/plugin-transform-modules-commonjs": "7.19.6",
+    "@babel/core": "7.20.7",
+    "@babel/plugin-transform-modules-commonjs": "7.20.11",
     "@babel/preset-typescript": "7.18.6",
-    "@swc/core": "1.3.23",
+    "@swc/core": "1.3.24",
     "@types/lodash": "4.14.191",
     "@types/node": "18.11.17",
     "@types/prompts": "2.4.2",
-    "@typescript-eslint/eslint-plugin": "5.46.1",
-    "@typescript-eslint/parser": "5.46.1",
+    "@typescript-eslint/eslint-plugin": "5.47.0",
+    "@typescript-eslint/parser": "5.47.0",
     "@vue/compiler-sfc": "3.2.45",
     "c8": "7.12.0",
     "chai": "4.3.7",
@@ -195,7 +197,7 @@
     "eslint-plugin-unicorn": "^45.0.0",
     "husky": "8.0.2",
     "intercept-stdout": "0.1.2",
-    "lint-staged": "12.3.4",
+    "lint-staged": "13.1.0",
     "mocha": "10.2.0",
     "normalize-newline": "^3.0.0",
     "npm-run-all": "4.1.5",
@@ -234,12 +236,7 @@
       {
         "package": "interpret",
         "policy": "wanted",
-        "because": "we want to keep interpret ~similar to what webpack-cli uses (which is ^2.2.0)"
-      },
-      {
-        "package": "lint-staged",
-        "policy": "pin",
-        "because": "12.3.5 fails with SyntaxError: Unexpected token o in JSON at position 1"
+        "because": "we want to keep interpret ~similar to what webpack-cli uses (which is ^3.1.0 since 2022-11-15)"
       },
       {
         "package": "normalize-newline",
@@ -249,7 +246,7 @@
       {
         "package": "rechoir",
         "policy": "wanted",
-        "because": "we want to keep rechoir ~similar to what webpack-cli uses (which is ^0.7.0, but ^0.8.0 is similar enough and more recent anyway)"
+        "because": "we want to keep rechoir ~similar to what webpack-cli uses (which is ^0.8.0 since 2022-11-15))"
       },
       {
         "package": "wrap-ansi",

package/src/cache/cache.js

@@ -21,7 +21,7 @@ function writeCache(pCacheFolder, pCruiseResult) {
 /**
  *
  * @param {string} pCacheFolder
- * @returns {import("../../types/cruise-result").ICruiseResult}
+ * @returns {import("../..").ICruiseResult}
  */
 function readCache(pCacheFolder) {
   try {
@@ -36,11 +36,11 @@ function readCache(pCacheFolder) {
 /**
  *
  * @param {import("../../types/strict-options").IStrictCruiseOptions} pOptions
- * @param {import("../../types/cruise-result").IRevisionData} pRevisionData
- * @returns
+ * @param {import("../..").IRevisionData} pRevisionData
+ * @returns {boolean}
  */
 function canServeFromCache(pOptions, pRevisionData) {
-  /** @type {import("../../types/cruise-result").ICruiseResult} */
+  /** @type {import("../..").ICruiseResult} */
   const lCachedResults = readCache(pOptions.cache);
 
   return (

package/src/cache/revision-data.js

@@ -36,10 +36,18 @@ function isInterestingChangeType(pInterestingChangeTypes) {
   return (pChange) => pInterestingChangeTypes.has(pChange.changeType);
 }
 
+/**
+ * @param {string} pString
+ * @returns {string}
+ */
 function hash(pString) {
   return createHash("sha1").update(pString).digest("base64");
 }
 
+/**
+ * @param {import("fs").PathOrFileDescriptor} pFileName
+ * @returns {string}
+ */
 function getFileHash(pFileName) {
   try {
     return hash(readFileSync(pFileName, "utf8"));
@@ -50,7 +58,7 @@ function getFileHash(pFileName) {
 
 /**
  * @param {import("watskeburt").IChange} pChange
- * @param {import("../../types/cruise-result").IRevisionChange}
+ * @param {import("../..").IRevisionChange}
  */
 function addChecksum(pChange) {
   return {
@@ -66,8 +74,8 @@ function addChecksum(pChange) {
  * @param {Object} pOptions
  * @param {() => string} pOptions.shaRetrievalFn
  * @param {(pString:string) => Array<import("watskeburt").IChange>} pOptions.diffListFn
- * @param {(import("watskeburt").IChange) => import("../../types/cruise-result").IRevisionChange} pOptions.checkSumFn
- * @returns {import("../../types/cruise-result").IRevisionData}
+ * @param {(import("watskeburt").IChange) => import("../..").IRevisionChange} pOptions.checkSumFn
+ * @returns {import("../..").IRevisionData}
  */
 function getRevisionData(
   pExtensions,
@@ -100,9 +108,8 @@ function getRevisionData(
 }
 
 /**
- *
- * @param {import("../../types/cruise-result").IRevisionData} pExistingRevisionData
- * @param {import("../../types/cruise-result").IRevisionData} pNewRevisionData
+ * @param {import("../..").IRevisionData} pExistingRevisionData
+ * @param {import("../..").IRevisionData} pNewRevisionData
  * @returns {boolean}
  */
 function revisionDataEqual(pExistingRevisionData, pNewRevisionData) {

package/src/cache/utl.js

@@ -4,6 +4,7 @@ const { deepEqual } = require("assert");
  *
  * @param {any} pLeftObject
  * @param {any} pRightObject
+ * @returns {boolean}
  */
 function objectsAreEqual(pLeftObject, pRightObject) {
   try {

package/src/cli/format.js

@@ -7,10 +7,10 @@ const io = require("./utl/io");
 /**
  *
  * @param {string} pResultFile the name of the file with cruise results
- * @param {import("../../types/dependency-cruiser").IFormatOptions} pOptions
+ * @param {import("../..").IFormatOptions} pOptions
  * @returns {Number} an exitCode
  */
-module.exports = async (pResultFile, pOptions) => {
+module.exports = async function format(pResultFile, pOptions) {
   const lOptions = normalizeOptions(pOptions);
 
   if (pResultFile !== "-") {

package/src/cli/index.js

@@ -1,6 +1,6 @@
 const path = require("path");
 const glob = require("glob");
-const clone = require("lodash/clone");
+const cloneDeep = require("lodash/cloneDeep");
 const set = require("lodash/set");
 const isInstalledGlobally = require("is-installed-globally");
 const { red, yellow, bold } = require("chalk");
@@ -42,7 +42,7 @@ function addKnownViolations(pCruiseOptions) {
 
     // Check against json schema is already done in src/main/options/validate
     // so here we can just concentrate on the io
-    let lCruiseOptions = clone(pCruiseOptions);
+    let lCruiseOptions = cloneDeep(pCruiseOptions);
     set(lCruiseOptions, "ruleSet.options.knownViolations", lKnownViolations);
     return lCruiseOptions;
   }
@@ -119,7 +119,6 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
   bus.emit("progress", "cli: writing results");
   bus.emit("write-start");
   io.write(lCruiseOptions.outputTo, lReportingResult.output);
-  bus.emit("end");
 
   return lReportingResult.exitCode;
 }
@@ -127,11 +126,11 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
 /**
  *
  * @param {string[]} pFileDirectoryArray
- * @param {import("../../types/options").ICruiseOptions} pCruiseOptions
+ * @param {import("../../types/options").ICruiseOptions} lCruiseOptions
  * @returns {number}
  */
 module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
-  pCruiseOptions = pCruiseOptions || {};
+  let lCruiseOptions = pCruiseOptions || {};
   let lExitCode = 0;
 
   try {
@@ -150,9 +149,9 @@ module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
       );
     }
     /* c8 ignore stop */
-    if (pCruiseOptions.info === true) {
+    if (lCruiseOptions.info === true) {
       process.stdout.write(formatMetaInfo());
-    } else if (pCruiseOptions.init) {
+    } 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
@@ -161,15 +160,15 @@ module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
       // holds.
       // eslint-disable-next-line node/global-require
       const initConfig = require("./init-config");
-      initConfig(pCruiseOptions.init);
+      initConfig(lCruiseOptions.init);
     } else {
-      lExitCode = runCruise(pFileDirectoryArray, pCruiseOptions);
+      lExitCode = runCruise(pFileDirectoryArray, lCruiseOptions);
     }
   } catch (pError) {
     process.stderr.write(`\n  ${red("ERROR")}: ${pError.message}\n`);
     bus.emit("end");
     lExitCode = 1;
   }
-
+  bus.emit("end");
   return lExitCode;
 };

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

@@ -1,17 +1,36 @@
+// @ts-check
 const Handlebars = require("handlebars/runtime");
-
 const { folderNameArrayToRE } = require("./utl");
 
 /* eslint import/no-unassigned-import: 0 */
 require("./config.js.template");
 
+/**
+ * @param {string} pString
+ * @returns {string}
+ */
+function quote(pString) {
+  return `"${pString}"`;
+}
+
+/**
+ * @param {string[]=} pExtensions
+ * @returns {string}
+ */
+function extensionsToString(pExtensions) {
+  if (pExtensions) {
+    return `[${pExtensions.map(quote).join(", ")}]`;
+  }
+  return "";
+}
+
 /**
  * Creates a .dependency-cruiser config with a set of basic validations
  * to the current directory.
  *
- * @returns {void}  Nothing
- * @param  {any}    pNormalizedInitOptions Options that influence the shape of
+ * @param {import("./types").IInitConfig} pNormalizedInitOptions Options that influence the shape of
  *                  the configuration
+ * @returns {string} the configuration as a string
  */
 
 module.exports = function buildConfig(pNormalizedInitOptions) {
@@ -22,5 +41,8 @@ module.exports = function buildConfig(pNormalizedInitOptions) {
       pNormalizedInitOptions.sourceLocation
     ),
     testLocationRE: folderNameArrayToRE(pNormalizedInitOptions.testLocation),
+    resolutionExtensionsAsString: extensionsToString(
+      pNormalizedInitOptions.resolutionExtensions
+    ),
   });
 };

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

@@ -1 +1 @@
-var Handlebars=require("handlebars/runtime"),template=Handlebars.template,templates=Handlebars.templates=Handlebars.templates||{};templates["config.js.template.hbs"]=template({1:function(e,n,t,o,s){var i,r=null!=n?n:e.nullContext||{},a=e.hooks.helperMissing,l="function",c=e.escapeExpression,e=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"  'extends': '"+c(typeof(i=null!=(i=e(t,"preset")||(null!=n?e(n,"preset"):n))?i:a)==l?i.call(r,{name:"preset",hash:{},data:s,loc:{start:{line:4,column:14},end:{line:4,column:24}}}):i)+"',\n  /*\n     the '"+c(typeof(i=null!=(i=e(t,"preset")||(null!=n?e(n,"preset"):n))?i:a)==l?i.call(r,{name:"preset",hash:{},data:s,loc:{start:{line:6,column:10},end:{line:6,column:20}}}):i)+"' preset\n     contains these rules:\n     no-circular          - flags all circular dependencies\n     no-orphans           - flags orphan modules (except typescript .d.ts files)\n     no-deprecated-core   - flags dependencies on deprecated node 'core' modules\n     no-deprecated-npm    - flags dependencies on deprecated npm modules\n     no-non-package-json  - flags (npm) dependencies that don't occur in package.json\n     not-to-unresolvable  - flags dependencies that can't be resolved`\n     no-duplicate-dep-types - flags dependencies that occur more than once in package.json\n\n     If you need to, you can override these rules. E.g. to ignore the\n     no-duplicate-dep-types rule, you can set its severity to \"ignore\" by\n     adding this to the 'forbidden' section:\n     {\n      name: 'no-duplicate-dep-types',\n      severity: 'ignore'\n     }\n\n     Also, by default, the preset does not follow any external modules (things in\n     node_modules or in yarn's plug'n'play magic). If you want to have that\n     differently, just override it the options.doNotFollow key.\n   */\n  forbidden: [\n"},3:function(e,n,t,o,s){return"  forbidden: [\n    /* rules from the 'recommended' preset: */\n    {\n      name: 'no-circular',\n      severity: 'warn',\n      comment:\n        'This dependency is part of a circular relationship. You might want to revise ' +\n        'your solution (i.e. use dependency inversion, make sure the modules have a single responsibility) ',\n      from: {},\n      to: {\n        circular: true\n      }\n    },\n    {\n      name: 'no-orphans',\n      comment:\n        \"This is an orphan module - it's likely not used (anymore?). Either use it or \" +\n        \"remove it. If it's logical this module is an orphan (i.e. it's a config file), \" +\n        \"add an exception for it in your dependency-cruiser configuration. By default \" +\n        \"this rule does not scrutinize dot-files (e.g. .eslintrc.js), TypeScript declaration \" +\n        \"files (.d.ts), tsconfig.json and some of the babel and webpack configs.\",\n      severity: 'warn',\n      from: {\n        orphan: true,\n        pathNot: [\n          '(^|/)\\\\.[^/]+\\\\.(js|cjs|mjs|ts|json)$', // dot files\n          '\\\\.d\\\\.ts$',                            // TypeScript declaration files\n          '(^|/)tsconfig\\\\.json$',                 // TypeScript config\n          '(^|/)(babel|webpack)\\\\.config\\\\.(js|cjs|mjs|ts|json)$' // other configs\n        ]\n      },\n      to: {},\n    },\n    {\n      name: 'no-deprecated-core',\n      comment:\n        'A module depends on a node core module that has been deprecated. Find an alternative - these are ' +\n        \"bound to exist - node doesn't deprecate lightly.\",\n      severity: 'warn',\n      from: {},\n      to: {\n        dependencyTypes: [\n          'core'\n        ],\n        path: [\n          '^(v8\\/tools\\/codemap)$',\n          '^(v8\\/tools\\/consarray)$',\n          '^(v8\\/tools\\/csvparser)$',\n          '^(v8\\/tools\\/logreader)$',\n          '^(v8\\/tools\\/profile_view)$',\n          '^(v8\\/tools\\/profile)$',\n          '^(v8\\/tools\\/SourceMap)$',\n          '^(v8\\/tools\\/splaytree)$',\n          '^(v8\\/tools\\/tickprocessor-driver)$',\n          '^(v8\\/tools\\/tickprocessor)$',\n          '^(node-inspect\\/lib\\/_inspect)$',\n          '^(node-inspect\\/lib\\/internal\\/inspect_client)$',\n          '^(node-inspect\\/lib\\/internal\\/inspect_repl)$',\n          '^(async_hooks)$',\n          '^(punycode)$',\n          '^(domain)$',\n          '^(constants)$',\n          '^(sys)$',\n          '^(_linklist)$',\n          '^(_stream_wrap)$'\n        ],\n      }\n    },\n    {\n      name: 'not-to-deprecated',\n      comment:\n        'This module uses a (version of an) npm module that has been deprecated. Either upgrade to a later ' +\n        'version of that module, or find an alternative. Deprecated modules are a security risk.',\n      severity: 'warn',\n      from: {},\n      to: {\n        dependencyTypes: [\n          'deprecated'\n        ]\n      }\n    },\n    {\n      name: 'no-non-package-json',\n      severity: 'error',\n      comment:\n        \"This module depends on an npm package that isn't in the 'dependencies' section of your package.json. \" +\n        \"That's problematic as the package either (1) won't be available on live (2 - worse) will be \" +\n        \"available on live with an non-guaranteed version. Fix it by adding the package to the dependencies \" +\n        \"in your package.json.\",\n      from: {},\n      to: {\n        dependencyTypes: [\n          'npm-no-pkg',\n          'npm-unknown'\n        ]\n      }\n    },\n    {\n      name: 'not-to-unresolvable',\n      comment:\n        \"This module depends on a module that cannot be found ('resolved to disk'). If it's an npm \" +\n        'module: add it to your package.json. In all other cases you likely already know what to do.',\n      severity: 'error',\n      from: {},\n      to: {\n        couldNotResolve: true\n      }\n    },\n    {\n      name: 'no-duplicate-dep-types',\n      comment:\n        \"Likely this module depends on an external ('npm') package that occurs more than once \" +\n        \"in your package.json i.e. bot as a devDependencies and in dependencies. This will cause \" +\n        \"maintenance problems later on.\",\n      severity: 'warn',\n      from: {},\n      to: {\n        moreThanOneDependencyType: true,\n        // as it's pretty common to have a type import be a type only import \n        // _and_ (e.g.) a devDependency - don't consider type-only dependency\n        // types for this rule\n        dependencyTypesNot: [\"type-only\"]\n      }\n    },\n\n    /* rules you might want to tweak for your specific situation: */\n"},5:function(e,n,t,o,s){var i,r=null!=n?n:e.nullContext||{},a=e.hooks.helperMissing,l="function",c=e.escapeExpression,e=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    {\n      name: 'not-to-test',\n      comment:\n        \"This module depends on code within a folder that should only contain tests. As tests don't \" +\n        \"implement functionality this is odd. Either you're writing a test outside the test folder \" +\n        \"or there's something in the test folder that isn't a test.\",\n      severity: 'error',\n      from: {\n        pathNot: '"+c(typeof(i=null!=(i=e(t,"testLocationRE")||(null!=n?e(n,"testLocationRE"):n))?i:a)==l?i.call(r,{name:"testLocationRE",hash:{},data:s,loc:{start:{line:166,column:18},end:{line:166,column:36}}}):i)+"'\n      },\n      to: {\n        path: '"+c(typeof(i=null!=(i=e(t,"testLocationRE")||(null!=n?e(n,"testLocationRE"):n))?i:a)==l?i.call(r,{name:"testLocationRE",hash:{},data:s,loc:{start:{line:169,column:15},end:{line:169,column:33}}}):i)+"'\n      }\n    },\n"},7:function(e,n,t,o,s){return"    tsPreCompilationDeps: true,\n"},9:function(e,n,t,o,s){return"    // tsPreCompilationDeps: false,\n"},11:function(e,n,t,o,s){return"    combinedDependencies: true,\n"},13:function(e,n,t,o,s){return"    // combinedDependencies: false,\n"},15:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    tsConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"tsConfig")||(null!=n?i(n,"tsConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"tsConfig",hash:{},data:s,loc:{start:{line:316,column:17},end:{line:316,column:29}}}):t)+"'\n    },\n"},17:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return null!=(t=i(t,"if").call(null!=n?n:e.nullContext||{},null!=n?i(n,"useJsConfig"):n,{name:"if",hash:{},fn:e.program(18,s,0),inverse:e.program(20,s,0),data:s,loc:{start:{line:319,column:6},end:{line:327,column:13}}}))?t:""},18:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    tsConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"jsConfig")||(null!=n?i(n,"jsConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"jsConfig",hash:{},data:s,loc:{start:{line:321,column:17},end:{line:321,column:29}}}):t)+"'\n    },\n"},20:function(e,n,t,o,s){return"    // tsConfig: {\n    //  fileName: './tsconfig.json'\n    // },\n"},22:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    webpackConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"webpackConfig")||(null!=n?i(n,"webpackConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"webpackConfig",hash:{},data:s,loc:{start:{line:342,column:17},end:{line:342,column:34}}}):t)+"',\n      // env: {},\n      // args: {},\n    },\n"},24:function(e,n,t,o,s){return"    // webpackConfig: {\n    //  fileName: './webpack.config.js',\n    //  env: {},\n    //  args: {},\n    // },\n"},26:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    babelConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"babelConfig")||(null!=n?i(n,"babelConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"babelConfig",hash:{},data:s,loc:{start:{line:362,column:17},end:{line:362,column:32}}}):t)+"'\n    },\n"},28:function(e,n,t,o,s){return"    // babelConfig: {\n    //   fileName: './.babelrc'\n    // },\n"},compiler:[8,">= 4.3.0"],main:function(e,n,t,o,s){var i=null!=n?n:e.nullContext||{},r=e.hooks.helperMissing,a="function",l=e.escapeExpression,c=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]},p="/** @type {import('dependency-cruiser').IConfiguration} */\nmodule.exports = {\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"preset"):n,{name:"if",hash:{},fn:e.program(1,s,0),inverse:e.program(3,s,0),data:s,loc:{start:{line:3,column:0},end:{line:156,column:7}}}))?h:""),d=null!=(d=c(t,"hasTestsOutsideSource")||(null!=n?c(n,"hasTestsOutsideSource"):n))?d:r,u={name:"hasTestsOutsideSource",hash:{},fn:e.program(5,s,0),inverse:e.noop,data:s,loc:{start:{line:157,column:4},end:{line:172,column:30}}},h=typeof d==a?d.call(i,u):d;return null!=(h=c(t,"hasTestsOutsideSource")?h:e.hooks.blockHelperMissing.call(n,h,u))&&(p+=h),p+"    {\n      name: 'not-to-spec',\n      comment:\n        'This module depends on a spec (test) file. The sole responsibility of a spec file is to test code. ' +\n        \"If there's something in a spec that's of use to other modules, it doesn't have that single \" +\n        'responsibility anymore. Factor it out into (e.g.) a separate utility/ helper or a mock.',\n      severity: 'error',\n      from: {},\n      to: {\n        path: '\\\\.(spec|test)\\\\.(js|mjs|cjs|ts|ls|coffee|litcoffee|coffee\\\\.md)$'\n      }\n    },\n    {\n      name: 'not-to-dev-dep',\n      severity: 'error',\n      comment:\n        \"This module depends on an npm package from the 'devDependencies' section of your \" +\n        'package.json. It looks like something that ships to production, though. To prevent problems ' +\n        \"with npm packages that aren't there on production declare it (only!) in the 'dependencies'\" +\n        'section of your package.json. If this module is development only - add it to the ' +\n        'from.pathNot re of the not-to-dev-dep rule in the dependency-cruiser configuration',\n      from: {\n        path: '"+l(typeof(d=null!=(d=c(t,"sourceLocationRE")||(null!=n?c(n,"sourceLocationRE"):n))?d:r)==a?d.call(i,{name:"sourceLocationRE",hash:{},data:s,loc:{start:{line:195,column:15},end:{line:195,column:35}}}):d)+"',\n        pathNot: '\\\\.(spec|test)\\\\.(js|mjs|cjs|ts|ls|coffee|litcoffee|coffee\\\\.md)$'\n      },\n      to: {\n        dependencyTypes: [\n          'npm-dev'\n        ]\n      }\n    },\n    {\n      name: 'optional-deps-used',\n      severity: 'info',\n      comment:\n        \"This module depends on an npm package that is declared as an optional dependency \" +\n        \"in your package.json. As this makes sense in limited situations only, it's flagged here. \" +\n        \"If you're using an optional dependency here by design - add an exception to your\" +\n        \"dependency-cruiser configuration.\",\n      from: {},\n      to: {\n        dependencyTypes: [\n          'npm-optional'\n        ]\n      }\n    },\n    {\n      name: 'peer-deps-used',\n      comment:\n        \"This module depends on an npm package that is declared as a peer dependency \" +\n        \"in your package.json. This makes sense if your package is e.g. a plugin, but in \" +\n        \"other cases - maybe not so much. If the use of a peer dependency is intentional \" +\n        \"add an exception to your dependency-cruiser configuration.\",\n      severity: 'warn',\n      from: {},\n      to: {\n        dependencyTypes: [\n          'npm-peer'\n        ]\n      }\n    }\n  ],\n  options: {\n\n    /* conditions specifying which files not to follow further when encountered:\n       - path: a regular expression to match\n       - dependencyTypes: see https://github.com/sverweij/dependency-cruiser/blob/master/doc/rules-reference.md#dependencytypes-and-dependencytypesnot\n       for a complete list\n    */\n    doNotFollow: {\n      path: 'node_modules'\n    },\n\n    /* conditions specifying which dependencies to exclude\n       - path: a regular expression to match\n       - dynamic: a boolean indicating whether to ignore dynamic (true) or static (false) dependencies.\n          leave out if you want to exclude neither (recommended!)\n    */\n    // exclude : {\n    //   path: '',\n    //   dynamic: true\n    // },\n\n    /* pattern specifying which files to include (regular expression)\n       dependency-cruiser will skip everything not matching this pattern\n    */\n    // includeOnly : '',\n\n    /* dependency-cruiser will include modules matching against the focus\n       regular expression in its output, as well as their neighbours (direct\n       dependencies and dependents)\n    */\n    // focus : '',\n\n    /* list of module systems to cruise */\n    // moduleSystems: ['amd', 'cjs', 'es6', 'tsd'],\n\n    /* prefix for links in html and svg output (e.g. 'https://github.com/you/yourrepo/blob/develop/'\n       to open it on your online repo or `vscode://file/${process.cwd()}/` to \n       open it in visual studio code),\n     */\n    // prefix: '',\n\n    /* false (the default): ignore dependencies that only exist before typescript-to-javascript compilation\n       true: also detect dependencies that only exist before typescript-to-javascript compilation\n       \"specify\": for each dependency identify whether it only exists before compilation or also after\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"tsPreCompilationDeps"):n,{name:"if",hash:{},fn:e.program(7,s,0),inverse:e.program(9,s,0),data:s,loc:{start:{line:280,column:4},end:{line:284,column:11}}}))?h:"")+'    \n    /* \n       list of extensions to scan that aren\'t javascript or compile-to-javascript. \n       Empty by default. Only put extensions in here that you want to take into\n       account that are _not_ parsable. \n    */\n    // extraExtensionsToScan: [".json", ".jpg", ".png", ".svg", ".webp"],\n\n    /* if true combines the package.jsons found from the module up to the base\n       folder the cruise is initiated from. Useful for how (some) mono-repos\n       manage dependencies & dependency definitions.\n     */\n'+(null!=(h=c(t,"if").call(i,null!=n?c(n,"combinedDependencies"):n,{name:"if",hash:{},fn:e.program(11,s,0),inverse:e.program(13,s,0),data:s,loc:{start:{line:297,column:4},end:{line:301,column:11}}}))?h:"")+"\n    /* if true leave symlinks untouched, otherwise use the realpath */\n    // preserveSymlinks: false,\n\n    /* TypeScript project file ('tsconfig.json') to use for\n       (1) compilation and\n       (2) resolution (e.g. with the paths property)\n\n       The (optional) fileName attribute specifies which file to take (relative to\n       dependency-cruiser's current working directory). When not provided\n       defaults to './tsconfig.json'.\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"useTsConfig"):n,{name:"if",hash:{},fn:e.program(15,s,0),inverse:e.program(17,s,0),data:s,loc:{start:{line:314,column:4},end:{line:328,column:11}}}))?h:"")+"\n    /* Webpack configuration to use to get resolve options from.\n\n       The (optional) fileName attribute specifies which file to take (relative\n       to dependency-cruiser's current working directory. When not provided defaults\n       to './webpack.conf.js'.\n\n       The (optional) `env` and `args` attributes contain the parameters to be passed if\n       your webpack config is a function and takes them (see webpack documentation\n       for details)\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"useWebpackConfig"):n,{name:"if",hash:{},fn:e.program(22,s,0),inverse:e.program(24,s,0),data:s,loc:{start:{line:340,column:4},end:{line:352,column:11}}}))?h:"")+"\n    /* Babel config ('.babelrc', '.babelrc.json', '.babelrc.json5', ...) to use\n      for compilation (and whatever other naughty things babel plugins do to\n      source code). This feature is well tested and usable, but might change\n      behavior a bit over time (e.g. more precise results for used module \n      systems) without dependency-cruiser getting a major version bump.\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"useBabelConfig"):n,{name:"if",hash:{},fn:e.program(26,s,0),inverse:e.program(28,s,0),data:s,loc:{start:{line:360,column:4},end:{line:368,column:11}}}))?h:"")+'\n    /* List of strings you have in use in addition to cjs/ es6 requires\n       & imports to declare module dependencies. Use this e.g. if you\'ve\n       re-declared require, use a require-wrapper or use window.require as\n       a hack.\n    */\n    // exoticRequireStrings: [],\n    /* options to pass on to enhanced-resolve, the package dependency-cruiser\n       uses to resolve module references to disk. You can set most of these\n       options in a webpack.conf.js - this section is here for those\n       projects that don\'t have a separate webpack config file.\n\n       Note: settings in webpack.conf.js override the ones specified here.\n     */\n    enhancedResolveOptions: {\n      /* List of strings to consider as \'exports\' fields in package.json. Use\n         [\'exports\'] when you use packages that use such a field and your environment\n         supports it (e.g. node ^12.19 || >=14.7 or recent versions of webpack).\n\n         If you have an `exportsFields` attribute in your webpack config, that one\n         will have precedence over the one specified here.\n      */ \n      exportsFields: ["exports"],\n      /* List of conditions to check for in the exports field. e.g. use [\'imports\']\n         if you\'re only interested in exposed es6 modules, [\'require\'] for commonjs,\n         or all conditions at once `([\'import\', \'require\', \'node\', \'default\']`)\n         if anything goes for you. Only works when the \'exportsFields\' array is\n         non-empty.\n\n        If you have a \'conditionNames\' attribute in your webpack config, that one will\n        have precedence over the one specified here.\n      */\n      conditionNames: ["import", "require", "node", "default"]\n      /*\n         The extensions, by default are the same as the ones dependency-cruiser\n         can access (run `npx depcruise --info` to see which ones that are in\n         _your_ environment. If that list is larger than what you need (e.g. \n         it contains .js, .jsx, .ts, .tsx, .cts, .mts - but you don\'t use \n         TypeScript you can pass just the extensions you actually use (e.g. \n         [".js", ".jsx"]). This can speed up the most expensive step in \n         dependency cruising (module resolution) quite a bit.\n       */\n      // extensions: [".js", ".jsx", ".ts", ".tsx", ".d.ts"]\n    },\n    reporterOptions: {\n      dot: {\n        /* pattern of modules that can be consolidated in the detailed\n           graphical dependency graph. The default pattern in this configuration\n           collapses everything in node_modules to one folder deep so you see\n           the external modules, but not the innards your app depends upon.\n         */\n        collapsePattern: \'node_modules/[^/]+\',\n\n        /* Options to tweak the appearance of your graph.See\n           https://github.com/sverweij/dependency-cruiser/blob/master/doc/options-reference.md#reporteroptions\n           for details and some examples. If you don\'t specify a theme\n           don\'t worry - dependency-cruiser will fall back to the default one.\n        */\n        // theme: {\n        //   graph: {\n        //     /* use splines: "ortho" for straight lines. Be aware though\n        //       graphviz might take a long time calculating ortho(gonal)\n        //       routings.\n        //    */\n        //     splines: "true"\n        //   },\n        //   modules: [\n        //     {\n        //       criteria: { matchesFocus: true },\n        //       attributes: {\n        //         fillcolor: "lime",\n        //         penwidth: 2,\n        //       },\n        //     },\n        //     {\n        //       criteria: { matchesFocus: false },\n        //       attributes: {\n        //         fillcolor: "lightgrey",\n        //       },\n        //     },\n        //     {\n        //       criteria: { matchesReaches: true },\n        //       attributes: {\n        //         fillcolor: "lime",\n        //         penwidth: 2,\n        //       },\n        //     },\n        //     {\n        //       criteria: { matchesReaches: false },\n        //       attributes: {\n        //         fillcolor: "lightgrey",\n        //       },\n        //     },\n        //     {\n        //       criteria: { source: "^src/model" },\n        //       attributes: { fillcolor: "#ccccff" }\n        //     },\n        //     {\n        //       criteria: { source: "^src/view" },\n        //       attributes: { fillcolor: "#ccffcc" }\n        //     },\n        //   ],\n        //   dependencies: [\n        //     {\n        //       criteria: { "rules[0].severity": "error" },\n        //       attributes: { fontcolor: "red", color: "red" }\n        //     },\n        //     {\n        //       criteria: { "rules[0].severity": "warn" },\n        //       attributes: { fontcolor: "orange", color: "orange" }\n        //     },\n        //     {\n        //       criteria: { "rules[0].severity": "info" },\n        //       attributes: { fontcolor: "blue", color: "blue" }\n        //     },\n        //     {\n        //       criteria: { resolved: "^src/model" },\n        //       attributes: { color: "#0000ff77" }\n        //     },\n        //     {\n        //       criteria: { resolved: "^src/view" },\n        //       attributes: { color: "#00770077" }\n        //     }\n        //   ]\n        // }\n      },\n      archi: {\n        /* pattern of modules that can be consolidated in the high level\n          graphical dependency graph. If you use the high level graphical\n          dependency graph reporter (`archi`) you probably want to tweak\n          this collapsePattern to your situation.\n        */\n        collapsePattern: \'^(packages|src|lib|app|bin|test(s?)|spec(s?))/[^/]+|node_modules/[^/]+\',\n\n        /* Options to tweak the appearance of your graph.See\n           https://github.com/sverweij/dependency-cruiser/blob/master/doc/options-reference.md#reporteroptions\n           for details and some examples. If you don\'t specify a theme\n           for \'archi\' dependency-cruiser will use the one specified in the\n           dot section (see above), if any, and otherwise use the default one.\n         */\n        // theme: {\n        // },\n      },\n      "text": {\n        "highlightFocused": true\n      },\n    }\n  }\n};\n// generated: dependency-cruiser@'+l(typeof(d=null!=(d=c(t,"version")||(null!=n?c(n,"version"):n))?d:r)==a?d.call(i,{name:"version",hash:{},data:s,loc:{start:{line:518,column:33},end:{line:518,column:44}}}):d)+" on "+l(typeof(d=null!=(d=c(t,"date")||(null!=n?c(n,"date"):n))?d:r)==a?d.call(i,{name:"date",hash:{},data:s,loc:{start:{line:518,column:48},end:{line:518,column:56}}}):d)+"\n"},useData:!0});
+var Handlebars=require("handlebars/runtime"),template=Handlebars.template,templates=Handlebars.templates=Handlebars.templates||{};templates["config.js.template.hbs"]=template({1:function(e,n,t,o,s){var i,r=null!=n?n:e.nullContext||{},a=e.hooks.helperMissing,l="function",c=e.escapeExpression,e=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"  'extends': '"+c(typeof(i=null!=(i=e(t,"preset")||(null!=n?e(n,"preset"):n))?i:a)==l?i.call(r,{name:"preset",hash:{},data:s,loc:{start:{line:4,column:14},end:{line:4,column:24}}}):i)+"',\n  /*\n     the '"+c(typeof(i=null!=(i=e(t,"preset")||(null!=n?e(n,"preset"):n))?i:a)==l?i.call(r,{name:"preset",hash:{},data:s,loc:{start:{line:6,column:10},end:{line:6,column:20}}}):i)+"' preset\n     contains these rules:\n     no-circular          - flags all circular dependencies\n     no-orphans           - flags orphan modules (except typescript .d.ts files)\n     no-deprecated-core   - flags dependencies on deprecated node 'core' modules\n     no-deprecated-npm    - flags dependencies on deprecated npm modules\n     no-non-package-json  - flags (npm) dependencies that don't occur in package.json\n     not-to-unresolvable  - flags dependencies that can't be resolved`\n     no-duplicate-dep-types - flags dependencies that occur more than once in package.json\n\n     If you need to, you can override these rules. E.g. to ignore the\n     no-duplicate-dep-types rule, you can set its severity to \"ignore\" by\n     adding this to the 'forbidden' section:\n     {\n      name: 'no-duplicate-dep-types',\n      severity: 'ignore'\n     }\n\n     Also, by default, the preset does not follow any external modules (things in\n     node_modules or in yarn's plug'n'play magic). If you want to have that\n     differently, just override it the options.doNotFollow key.\n   */\n  forbidden: [\n"},3:function(e,n,t,o,s){return"  forbidden: [\n    /* rules from the 'recommended' preset: */\n    {\n      name: 'no-circular',\n      severity: 'warn',\n      comment:\n        'This dependency is part of a circular relationship. You might want to revise ' +\n        'your solution (i.e. use dependency inversion, make sure the modules have a single responsibility) ',\n      from: {},\n      to: {\n        circular: true\n      }\n    },\n    {\n      name: 'no-orphans',\n      comment:\n        \"This is an orphan module - it's likely not used (anymore?). Either use it or \" +\n        \"remove it. If it's logical this module is an orphan (i.e. it's a config file), \" +\n        \"add an exception for it in your dependency-cruiser configuration. By default \" +\n        \"this rule does not scrutinize dot-files (e.g. .eslintrc.js), TypeScript declaration \" +\n        \"files (.d.ts), tsconfig.json and some of the babel and webpack configs.\",\n      severity: 'warn',\n      from: {\n        orphan: true,\n        pathNot: [\n          '(^|/)\\\\.[^/]+\\\\.(js|cjs|mjs|ts|json)$', // dot files\n          '\\\\.d\\\\.ts$',                            // TypeScript declaration files\n          '(^|/)tsconfig\\\\.json$',                 // TypeScript config\n          '(^|/)(babel|webpack)\\\\.config\\\\.(js|cjs|mjs|ts|json)$' // other configs\n        ]\n      },\n      to: {},\n    },\n    {\n      name: 'no-deprecated-core',\n      comment:\n        'A module depends on a node core module that has been deprecated. Find an alternative - these are ' +\n        \"bound to exist - node doesn't deprecate lightly.\",\n      severity: 'warn',\n      from: {},\n      to: {\n        dependencyTypes: [\n          'core'\n        ],\n        path: [\n          '^(v8\\/tools\\/codemap)$',\n          '^(v8\\/tools\\/consarray)$',\n          '^(v8\\/tools\\/csvparser)$',\n          '^(v8\\/tools\\/logreader)$',\n          '^(v8\\/tools\\/profile_view)$',\n          '^(v8\\/tools\\/profile)$',\n          '^(v8\\/tools\\/SourceMap)$',\n          '^(v8\\/tools\\/splaytree)$',\n          '^(v8\\/tools\\/tickprocessor-driver)$',\n          '^(v8\\/tools\\/tickprocessor)$',\n          '^(node-inspect\\/lib\\/_inspect)$',\n          '^(node-inspect\\/lib\\/internal\\/inspect_client)$',\n          '^(node-inspect\\/lib\\/internal\\/inspect_repl)$',\n          '^(async_hooks)$',\n          '^(punycode)$',\n          '^(domain)$',\n          '^(constants)$',\n          '^(sys)$',\n          '^(_linklist)$',\n          '^(_stream_wrap)$'\n        ],\n      }\n    },\n    {\n      name: 'not-to-deprecated',\n      comment:\n        'This module uses a (version of an) npm module that has been deprecated. Either upgrade to a later ' +\n        'version of that module, or find an alternative. Deprecated modules are a security risk.',\n      severity: 'warn',\n      from: {},\n      to: {\n        dependencyTypes: [\n          'deprecated'\n        ]\n      }\n    },\n    {\n      name: 'no-non-package-json',\n      severity: 'error',\n      comment:\n        \"This module depends on an npm package that isn't in the 'dependencies' section of your package.json. \" +\n        \"That's problematic as the package either (1) won't be available on live (2 - worse) will be \" +\n        \"available on live with an non-guaranteed version. Fix it by adding the package to the dependencies \" +\n        \"in your package.json.\",\n      from: {},\n      to: {\n        dependencyTypes: [\n          'npm-no-pkg',\n          'npm-unknown'\n        ]\n      }\n    },\n    {\n      name: 'not-to-unresolvable',\n      comment:\n        \"This module depends on a module that cannot be found ('resolved to disk'). If it's an npm \" +\n        'module: add it to your package.json. In all other cases you likely already know what to do.',\n      severity: 'error',\n      from: {},\n      to: {\n        couldNotResolve: true\n      }\n    },\n    {\n      name: 'no-duplicate-dep-types',\n      comment:\n        \"Likely this module depends on an external ('npm') package that occurs more than once \" +\n        \"in your package.json i.e. bot as a devDependencies and in dependencies. This will cause \" +\n        \"maintenance problems later on.\",\n      severity: 'warn',\n      from: {},\n      to: {\n        moreThanOneDependencyType: true,\n        // as it's pretty common to have a type import be a type only import \n        // _and_ (e.g.) a devDependency - don't consider type-only dependency\n        // types for this rule\n        dependencyTypesNot: [\"type-only\"]\n      }\n    },\n\n    /* rules you might want to tweak for your specific situation: */\n"},5:function(e,n,t,o,s){var i,r=null!=n?n:e.nullContext||{},a=e.hooks.helperMissing,l="function",c=e.escapeExpression,e=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    {\n      name: 'not-to-test',\n      comment:\n        \"This module depends on code within a folder that should only contain tests. As tests don't \" +\n        \"implement functionality this is odd. Either you're writing a test outside the test folder \" +\n        \"or there's something in the test folder that isn't a test.\",\n      severity: 'error',\n      from: {\n        pathNot: '"+c(typeof(i=null!=(i=e(t,"testLocationRE")||(null!=n?e(n,"testLocationRE"):n))?i:a)==l?i.call(r,{name:"testLocationRE",hash:{},data:s,loc:{start:{line:166,column:18},end:{line:166,column:36}}}):i)+"'\n      },\n      to: {\n        path: '"+c(typeof(i=null!=(i=e(t,"testLocationRE")||(null!=n?e(n,"testLocationRE"):n))?i:a)==l?i.call(r,{name:"testLocationRE",hash:{},data:s,loc:{start:{line:169,column:15},end:{line:169,column:33}}}):i)+"'\n      }\n    },\n"},7:function(e,n,t,o,s){return"    tsPreCompilationDeps: true,\n"},9:function(e,n,t,o,s){return"    // tsPreCompilationDeps: false,\n"},11:function(e,n,t,o,s){return"    combinedDependencies: true,\n"},13:function(e,n,t,o,s){return"    // combinedDependencies: false,\n"},15:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    tsConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"tsConfig")||(null!=n?i(n,"tsConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"tsConfig",hash:{},data:s,loc:{start:{line:316,column:17},end:{line:316,column:29}}}):t)+"'\n    },\n"},17:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return null!=(t=i(t,"if").call(null!=n?n:e.nullContext||{},null!=n?i(n,"useJsConfig"):n,{name:"if",hash:{},fn:e.program(18,s,0),inverse:e.program(20,s,0),data:s,loc:{start:{line:319,column:6},end:{line:327,column:13}}}))?t:""},18:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    tsConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"jsConfig")||(null!=n?i(n,"jsConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"jsConfig",hash:{},data:s,loc:{start:{line:321,column:17},end:{line:321,column:29}}}):t)+"'\n    },\n"},20:function(e,n,t,o,s){return"    // tsConfig: {\n    //  fileName: './tsconfig.json'\n    // },\n"},22:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    webpackConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"webpackConfig")||(null!=n?i(n,"webpackConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"webpackConfig",hash:{},data:s,loc:{start:{line:342,column:17},end:{line:342,column:34}}}):t)+"',\n      // env: {},\n      // args: {},\n    },\n"},24:function(e,n,t,o,s){return"    // webpackConfig: {\n    //  fileName: './webpack.config.js',\n    //  env: {},\n    //  args: {},\n    // },\n"},26:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"    babelConfig: {\n      fileName: '"+e.escapeExpression("function"==typeof(t=null!=(t=i(t,"babelConfig")||(null!=n?i(n,"babelConfig"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"babelConfig",hash:{},data:s,loc:{start:{line:362,column:17},end:{line:362,column:32}}}):t)+"'\n    },\n"},28:function(e,n,t,o,s){return"    // babelConfig: {\n    //   fileName: './.babelrc'\n    // },\n"},30:function(e,n,t,o,s){var i=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]};return"      extensions: "+(null!=(i="function"==typeof(t=null!=(t=i(t,"resolutionExtensionsAsString")||(null!=n?i(n,"resolutionExtensionsAsString"):n))?t:e.hooks.helperMissing)?t.call(null!=n?n:e.nullContext||{},{name:"resolutionExtensionsAsString",hash:{},data:s,loc:{start:{line:412,column:18},end:{line:412,column:52}}}):t)?i:"")+",\n"},32:function(e,n,t,o,s){return'      // extensions: [".js", ".jsx", ".ts", ".tsx", ".d.ts"]\n'},compiler:[8,">= 4.3.0"],main:function(e,n,t,o,s){var i=null!=n?n:e.nullContext||{},r=e.hooks.helperMissing,a="function",l=e.escapeExpression,c=e.lookupProperty||function(e,n){if(Object.prototype.hasOwnProperty.call(e,n))return e[n]},p="/** @type {import('dependency-cruiser').IConfiguration} */\nmodule.exports = {\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"preset"):n,{name:"if",hash:{},fn:e.program(1,s,0),inverse:e.program(3,s,0),data:s,loc:{start:{line:3,column:0},end:{line:156,column:7}}}))?h:""),u=null!=(u=c(t,"hasTestsOutsideSource")||(null!=n?c(n,"hasTestsOutsideSource"):n))?u:r,d={name:"hasTestsOutsideSource",hash:{},fn:e.program(5,s,0),inverse:e.noop,data:s,loc:{start:{line:157,column:4},end:{line:172,column:30}}},h=typeof u==a?u.call(i,d):u;return null!=(h=c(t,"hasTestsOutsideSource")?h:e.hooks.blockHelperMissing.call(n,h,d))&&(p+=h),p+"    {\n      name: 'not-to-spec',\n      comment:\n        'This module depends on a spec (test) file. The sole responsibility of a spec file is to test code. ' +\n        \"If there's something in a spec that's of use to other modules, it doesn't have that single \" +\n        'responsibility anymore. Factor it out into (e.g.) a separate utility/ helper or a mock.',\n      severity: 'error',\n      from: {},\n      to: {\n        path: '\\\\.(spec|test)\\\\.(js|mjs|cjs|ts|ls|coffee|litcoffee|coffee\\\\.md)$'\n      }\n    },\n    {\n      name: 'not-to-dev-dep',\n      severity: 'error',\n      comment:\n        \"This module depends on an npm package from the 'devDependencies' section of your \" +\n        'package.json. It looks like something that ships to production, though. To prevent problems ' +\n        \"with npm packages that aren't there on production declare it (only!) in the 'dependencies'\" +\n        'section of your package.json. If this module is development only - add it to the ' +\n        'from.pathNot re of the not-to-dev-dep rule in the dependency-cruiser configuration',\n      from: {\n        path: '"+l(typeof(u=null!=(u=c(t,"sourceLocationRE")||(null!=n?c(n,"sourceLocationRE"):n))?u:r)==a?u.call(i,{name:"sourceLocationRE",hash:{},data:s,loc:{start:{line:195,column:15},end:{line:195,column:35}}}):u)+"',\n        pathNot: '\\\\.(spec|test)\\\\.(js|mjs|cjs|ts|ls|coffee|litcoffee|coffee\\\\.md)$'\n      },\n      to: {\n        dependencyTypes: [\n          'npm-dev'\n        ]\n      }\n    },\n    {\n      name: 'optional-deps-used',\n      severity: 'info',\n      comment:\n        \"This module depends on an npm package that is declared as an optional dependency \" +\n        \"in your package.json. As this makes sense in limited situations only, it's flagged here. \" +\n        \"If you're using an optional dependency here by design - add an exception to your\" +\n        \"dependency-cruiser configuration.\",\n      from: {},\n      to: {\n        dependencyTypes: [\n          'npm-optional'\n        ]\n      }\n    },\n    {\n      name: 'peer-deps-used',\n      comment:\n        \"This module depends on an npm package that is declared as a peer dependency \" +\n        \"in your package.json. This makes sense if your package is e.g. a plugin, but in \" +\n        \"other cases - maybe not so much. If the use of a peer dependency is intentional \" +\n        \"add an exception to your dependency-cruiser configuration.\",\n      severity: 'warn',\n      from: {},\n      to: {\n        dependencyTypes: [\n          'npm-peer'\n        ]\n      }\n    }\n  ],\n  options: {\n\n    /* conditions specifying which files not to follow further when encountered:\n       - path: a regular expression to match\n       - dependencyTypes: see https://github.com/sverweij/dependency-cruiser/blob/master/doc/rules-reference.md#dependencytypes-and-dependencytypesnot\n       for a complete list\n    */\n    doNotFollow: {\n      path: 'node_modules'\n    },\n\n    /* conditions specifying which dependencies to exclude\n       - path: a regular expression to match\n       - dynamic: a boolean indicating whether to ignore dynamic (true) or static (false) dependencies.\n          leave out if you want to exclude neither (recommended!)\n    */\n    // exclude : {\n    //   path: '',\n    //   dynamic: true\n    // },\n\n    /* pattern specifying which files to include (regular expression)\n       dependency-cruiser will skip everything not matching this pattern\n    */\n    // includeOnly : '',\n\n    /* dependency-cruiser will include modules matching against the focus\n       regular expression in its output, as well as their neighbours (direct\n       dependencies and dependents)\n    */\n    // focus : '',\n\n    /* list of module systems to cruise */\n    // moduleSystems: ['amd', 'cjs', 'es6', 'tsd'],\n\n    /* prefix for links in html and svg output (e.g. 'https://github.com/you/yourrepo/blob/develop/'\n       to open it on your online repo or `vscode://file/${process.cwd()}/` to \n       open it in visual studio code),\n     */\n    // prefix: '',\n\n    /* false (the default): ignore dependencies that only exist before typescript-to-javascript compilation\n       true: also detect dependencies that only exist before typescript-to-javascript compilation\n       \"specify\": for each dependency identify whether it only exists before compilation or also after\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"tsPreCompilationDeps"):n,{name:"if",hash:{},fn:e.program(7,s,0),inverse:e.program(9,s,0),data:s,loc:{start:{line:280,column:4},end:{line:284,column:11}}}))?h:"")+'    \n    /* \n       list of extensions to scan that aren\'t javascript or compile-to-javascript. \n       Empty by default. Only put extensions in here that you want to take into\n       account that are _not_ parsable. \n    */\n    // extraExtensionsToScan: [".json", ".jpg", ".png", ".svg", ".webp"],\n\n    /* if true combines the package.jsons found from the module up to the base\n       folder the cruise is initiated from. Useful for how (some) mono-repos\n       manage dependencies & dependency definitions.\n     */\n'+(null!=(h=c(t,"if").call(i,null!=n?c(n,"combinedDependencies"):n,{name:"if",hash:{},fn:e.program(11,s,0),inverse:e.program(13,s,0),data:s,loc:{start:{line:297,column:4},end:{line:301,column:11}}}))?h:"")+"\n    /* if true leave symlinks untouched, otherwise use the realpath */\n    // preserveSymlinks: false,\n\n    /* TypeScript project file ('tsconfig.json') to use for\n       (1) compilation and\n       (2) resolution (e.g. with the paths property)\n\n       The (optional) fileName attribute specifies which file to take (relative to\n       dependency-cruiser's current working directory). When not provided\n       defaults to './tsconfig.json'.\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"useTsConfig"):n,{name:"if",hash:{},fn:e.program(15,s,0),inverse:e.program(17,s,0),data:s,loc:{start:{line:314,column:4},end:{line:328,column:11}}}))?h:"")+"\n    /* Webpack configuration to use to get resolve options from.\n\n       The (optional) fileName attribute specifies which file to take (relative\n       to dependency-cruiser's current working directory. When not provided defaults\n       to './webpack.conf.js'.\n\n       The (optional) `env` and `args` attributes contain the parameters to be passed if\n       your webpack config is a function and takes them (see webpack documentation\n       for details)\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"useWebpackConfig"):n,{name:"if",hash:{},fn:e.program(22,s,0),inverse:e.program(24,s,0),data:s,loc:{start:{line:340,column:4},end:{line:352,column:11}}}))?h:"")+"\n    /* Babel config ('.babelrc', '.babelrc.json', '.babelrc.json5', ...) to use\n      for compilation (and whatever other naughty things babel plugins do to\n      source code). This feature is well tested and usable, but might change\n      behavior a bit over time (e.g. more precise results for used module \n      systems) without dependency-cruiser getting a major version bump.\n     */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"useBabelConfig"):n,{name:"if",hash:{},fn:e.program(26,s,0),inverse:e.program(28,s,0),data:s,loc:{start:{line:360,column:4},end:{line:368,column:11}}}))?h:"")+"\n    /* List of strings you have in use in addition to cjs/ es6 requires\n       & imports to declare module dependencies. Use this e.g. if you've\n       re-declared require, use a require-wrapper or use window.require as\n       a hack.\n    */\n    // exoticRequireStrings: [],\n    /* options to pass on to enhanced-resolve, the package dependency-cruiser\n       uses to resolve module references to disk. You can set most of these\n       options in a webpack.conf.js - this section is here for those\n       projects that don't have a separate webpack config file.\n\n       Note: settings in webpack.conf.js override the ones specified here.\n     */\n    enhancedResolveOptions: {\n      /* List of strings to consider as 'exports' fields in package.json. Use\n         ['exports'] when you use packages that use such a field and your environment\n         supports it (e.g. node ^12.19 || >=14.7 or recent versions of webpack).\n\n         If you have an `exportsFields` attribute in your webpack config, that one\n         will have precedence over the one specified here.\n      */ \n      exportsFields: [\"exports\"],\n      /* List of conditions to check for in the exports field. e.g. use ['imports']\n         if you're only interested in exposed es6 modules, ['require'] for commonjs,\n         or all conditions at once `(['import', 'require', 'node', 'default']`)\n         if anything goes for you. Only works when the 'exportsFields' array is\n         non-empty.\n\n        If you have a 'conditionNames' attribute in your webpack config, that one will\n        have precedence over the one specified here.\n      */\n      conditionNames: [\"import\", \"require\", \"node\", \"default\"],\n      /*\n         The extensions, by default are the same as the ones dependency-cruiser\n         can access (run `npx depcruise --info` to see which ones that are in\n         _your_ environment. If that list is larger than what you need (e.g. \n         it contains .js, .jsx, .ts, .tsx, .cts, .mts - but you don't use \n         TypeScript you can pass just the extensions you actually use (e.g. \n         [\".js\", \".jsx\"]). This can speed up the most expensive step in \n         dependency cruising (module resolution) quite a bit.\n       */\n"+(null!=(h=c(t,"if").call(i,null!=n?c(n,"specifyResolutionExtensions"):n,{name:"if",hash:{},fn:e.program(30,s,0),inverse:e.program(32,s,0),data:s,loc:{start:{line:411,column:6},end:{line:415,column:13}}}))?h:"")+'    },\n    reporterOptions: {\n      dot: {\n        /* pattern of modules that can be consolidated in the detailed\n           graphical dependency graph. The default pattern in this configuration\n           collapses everything in node_modules to one folder deep so you see\n           the external modules, but not the innards your app depends upon.\n         */\n        collapsePattern: \'node_modules/[^/]+\',\n\n        /* Options to tweak the appearance of your graph.See\n           https://github.com/sverweij/dependency-cruiser/blob/master/doc/options-reference.md#reporteroptions\n           for details and some examples. If you don\'t specify a theme\n           don\'t worry - dependency-cruiser will fall back to the default one.\n        */\n        // theme: {\n        //   graph: {\n        //     /* use splines: "ortho" for straight lines. Be aware though\n        //       graphviz might take a long time calculating ortho(gonal)\n        //       routings.\n        //    */\n        //     splines: "true"\n        //   },\n        //   modules: [\n        //     {\n        //       criteria: { matchesFocus: true },\n        //       attributes: {\n        //         fillcolor: "lime",\n        //         penwidth: 2,\n        //       },\n        //     },\n        //     {\n        //       criteria: { matchesFocus: false },\n        //       attributes: {\n        //         fillcolor: "lightgrey",\n        //       },\n        //     },\n        //     {\n        //       criteria: { matchesReaches: true },\n        //       attributes: {\n        //         fillcolor: "lime",\n        //         penwidth: 2,\n        //       },\n        //     },\n        //     {\n        //       criteria: { matchesReaches: false },\n        //       attributes: {\n        //         fillcolor: "lightgrey",\n        //       },\n        //     },\n        //     {\n        //       criteria: { source: "^src/model" },\n        //       attributes: { fillcolor: "#ccccff" }\n        //     },\n        //     {\n        //       criteria: { source: "^src/view" },\n        //       attributes: { fillcolor: "#ccffcc" }\n        //     },\n        //   ],\n        //   dependencies: [\n        //     {\n        //       criteria: { "rules[0].severity": "error" },\n        //       attributes: { fontcolor: "red", color: "red" }\n        //     },\n        //     {\n        //       criteria: { "rules[0].severity": "warn" },\n        //       attributes: { fontcolor: "orange", color: "orange" }\n        //     },\n        //     {\n        //       criteria: { "rules[0].severity": "info" },\n        //       attributes: { fontcolor: "blue", color: "blue" }\n        //     },\n        //     {\n        //       criteria: { resolved: "^src/model" },\n        //       attributes: { color: "#0000ff77" }\n        //     },\n        //     {\n        //       criteria: { resolved: "^src/view" },\n        //       attributes: { color: "#00770077" }\n        //     }\n        //   ]\n        // }\n      },\n      archi: {\n        /* pattern of modules that can be consolidated in the high level\n          graphical dependency graph. If you use the high level graphical\n          dependency graph reporter (`archi`) you probably want to tweak\n          this collapsePattern to your situation.\n        */\n        collapsePattern: \'^(packages|src|lib|app|bin|test(s?)|spec(s?))/[^/]+|node_modules/[^/]+\',\n\n        /* Options to tweak the appearance of your graph.See\n           https://github.com/sverweij/dependency-cruiser/blob/master/doc/options-reference.md#reporteroptions\n           for details and some examples. If you don\'t specify a theme\n           for \'archi\' dependency-cruiser will use the one specified in the\n           dot section (see above), if any, and otherwise use the default one.\n         */\n        // theme: {\n        // },\n      },\n      "text": {\n        "highlightFocused": true\n      },\n    }\n  }\n};\n// generated: dependency-cruiser@'+l(typeof(u=null!=(u=c(t,"version")||(null!=n?c(n,"version"):n))?u:r)==a?u.call(i,{name:"version",hash:{},data:s,loc:{start:{line:522,column:33},end:{line:522,column:44}}}):u)+" on "+l(typeof(u=null!=(u=c(t,"date")||(null!=n?c(n,"date"):n))?u:r)==a?u.call(i,{name:"date",hash:{},data:s,loc:{start:{line:522,column:48},end:{line:522,column:56}}}):u)+"\n"},useData:!0});

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

@@ -1,3 +1,4 @@
+// @ts-check
 const { readFileSync, readdirSync, accessSync, statSync, R_OK } = require("fs");
 const { join } = require("path");
 const has = require("lodash/has");
@@ -15,8 +16,8 @@ const BABEL_CONFIG_CANDIDATE_PATTERN = /^\.babelrc$|.*babel.*\.json/gi;
 /**
  * Read the package manifest ('package.json') and return it as a javascript object
  *
- * @param {string} pManifestFileName - the file name where the package manifest (package.json) lives
- * @returns {any} - the contents of said manifest as a javascript object
+ * @param {import("fs").PathOrFileDescriptor} pManifestFileName - the file name where the package manifest (package.json) lives
+ * @returns {Record<string,any>} - the contents of said manifest as a javascript object
  * @throws {ENOENT} when the manifest wasn't found
  * @throws {SyntaxError} when the manifest's json is invalid
  */
@@ -24,9 +25,12 @@ function readManifest(pManifestFileName = "./package.json") {
   return JSON.parse(readFileSync(pManifestFileName, "utf8"));
 }
 
-/*
-  We could have used utl.fileExists - but that one is cached.
-  Not typically what we want for this util.
+/**
+ * We could have used utl.fileExists - but that one is cached.
+ * Not typically what we want for this util.
+ *
+ * @param {import("fs").PathLike} pFile
+ * @returns {boolean}
  */
 function fileExists(pFile) {
   try {
@@ -37,6 +41,9 @@ function fileExists(pFile) {
   return true;
 }
 
+/**
+ * @returns {boolean}
+ */
 function babelIsConfiguredInManifest() {
   let lReturnValue = false;
 
@@ -48,6 +55,9 @@ function babelIsConfiguredInManifest() {
   return lReturnValue;
 }
 
+/**
+ * @returns {boolean}
+ */
 function isTypeModule() {
   let lReturnValue = false;
 
@@ -60,12 +70,21 @@ function isTypeModule() {
   return lReturnValue;
 }
 
+/**
+ * @param {string} pFolderName
+ * @returns {string[]} Array of folder names
+ */
 function getFolderNames(pFolderName) {
   return readdirSync(pFolderName, "utf8").filter((pFileName) =>
     statSync(join(pFolderName, pFileName)).isDirectory()
   );
 }
 
+/**
+ * @param {RegExp} pPattern
+ * @param {string=} pFolderName
+ * @returns {string[]}
+ */
 function getMatchingFileNames(pPattern, pFolderName = process.cwd()) {
   return readdirSync(pFolderName, "utf8").filter(
     (pFileName) =>
@@ -74,6 +93,10 @@ function getMatchingFileNames(pPattern, pFolderName = process.cwd()) {
   );
 }
 
+/**
+ * @param {string[]} pFolderNames
+ * @returns {boolean}
+ */
 function isLikelyMonoRepo(pFolderNames = getFolderNames(process.cwd())) {
   return pFolderNames.includes("packages");
 }
@@ -92,6 +115,10 @@ function getFolderCandidates(pCandidateFolderArray) {
   };
 }
 
+/**
+ * @param {string[]|string} pLocations
+ * @returns {string[]}
+ */
 function toSourceLocationArray(pLocations) {
   if (!Array.isArray(pLocations)) {
     return pLocations.split(",").map((pFolder) => pFolder.trim());
@@ -99,6 +126,9 @@ function toSourceLocationArray(pLocations) {
   return pLocations;
 }
 
+/**
+ * @returns {string[]}
+ */
 function getManifestFilesWithABabelConfig() {
   return babelIsConfiguredInManifest() ? ["package.json"] : [];
 }
@@ -129,6 +159,10 @@ const getTestFolderCandidates = getFolderCandidates(LIKELY_TEST_FOLDERS);
 const getMonoRepoPackagesCandidates = getFolderCandidates(
   LIKELY_PACKAGES_FOLDERS
 );
+
+/**
+ * @returns {string}
+ */
 function getDefaultConfigFileName() {
   return isTypeModule() ? ".dependency-cruiser.cjs" : DEFAULT_CONFIG_FILE_NAME;
 }