dependency-cruiser 16.0.0 → 16.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2023 Sander Verweij
+Copyright (c) 2016-2024 Sander Verweij
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "16.0.0",
+  "version": "16.1.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -98,76 +98,12 @@
     "package.json",
     "README.md"
   ],
-  "scripts": {
-    "build": "make build",
-    "build:clean": "make clean",
-    "check": "npm-run-all build lint depcruise test:cover",
-    "check:full": "npm-run-all check test:glob",
-    "depcruise": "node ./bin/dependency-cruise.mjs src bin test configs types tools --ignore-known",
-    "depcruise:all": "node ./bin/dependency-cruise.mjs src bin test configs types tools",
-    "depcruise:baseline": "node ./bin/depcruise-baseline.mjs src bin test configs types tools",
-    "depcruise:explain": "node ./bin/dependency-cruise.mjs src bin test configs types tools --output-type err-long --progress none",
-    "depcruise:graph:doc": "npm-run-all depcruise:graph:doc:json --parallel depcruise:graph:doc:fmt-* depcruise:graph:doc:samples",
-    "depcruise:graph:doc:json": "node ./bin/dependency-cruise.mjs bin src test --output-type json --output-to node_modules/.cache/tmp_graph_deps.json --progress",
-    "depcruise:graph:doc:fmt-detail": "./bin/depcruise-fmt.mjs -T dot -f - node_modules/.cache/tmp_graph_deps.json | dot -T svg | tee doc/real-world-samples/dependency-cruiser-without-node_modules.svg | node bin/wrap-stream-in-html.mjs > docs/dependency-cruiser-dependency-graph.html",
-    "depcruise:graph:doc:fmt-archi": "./bin/depcruise-fmt.mjs -T archi -f - node_modules/.cache/tmp_graph_deps.json | dot -T svg -Gordering=in -Grankdir=TD | tee doc/real-world-samples/dependency-cruiser-archi-graph.svg | node bin/wrap-stream-in-html.mjs > docs/dependency-cruiser-archi-graph.html",
-    "depcruise:graph:doc:fmt-dir": "./bin/depcruise-fmt.mjs -T ddot -f - node_modules/.cache/tmp_graph_deps.json | dot -T svg -Grankdir=TD | tee doc/real-world-samples/dependency-cruiser-dir-graph.svg | node bin/wrap-stream-in-html.mjs > docs/dependency-cruiser-dir-graph.html",
-    "depcruise:graph:doc:fmt-schema": "cd tools/schema && node ../../bin/dependency-cruise.mjs . --output-type dot | dot -T svg | tee ../overview.svg | node ../../bin/wrap-stream-in-html.mjs > ../../docs/schema-overview.html && cd -",
-    "depcruise:graph:doc:fmt-types": "cd types && node ../bin/dependency-cruise.mjs . --output-type dot | dot -T svg | tee overview.svg | ../bin/wrap-stream-in-html.mjs > overview.html && cd -",
-    "depcruise:graph:doc:samples": "sh tools/generate-samples.sh",
-    "depcruise:graph:mermaid": "node ./bin/dependency-cruise.mjs bin src --include-only ^src/ --collapse 2 --output-type mermaid",
-    "depcruise:graph:mermaid:diff": "node ./bin/dependency-cruise.mjs bin src test types tools --config configs/.dependency-cruiser-unlimited.mjs --output-type mermaid --reaches \"$(watskeburt $SHA)\"",
-    "depcruise:graph:view": "node ./bin/dependency-cruise.mjs bin src --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-show-metrics-config.mjs --output-type dot --progress cli-feedback --highlight \"$(watskeburt main)\" | dot -T svg | node ./bin/wrap-stream-in-html.mjs | browser",
-    "depcruise:graph:view:diff": "node ./bin/dependency-cruise.mjs bin src test --prefix vscode://file/$(pwd)/ --config configs/.dependency-cruiser-unlimited.mjs --output-type dot --progress cli-feedback --reaches \"$(watskeburt main)\" | dot -T svg | node ./bin/wrap-stream-in-html.mjs | browser",
-    "depcruise:report": "node ./bin/dependency-cruise.mjs src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.mjs --output-to dependency-violations.html",
-    "depcruise:report:view": "node ./bin/dependency-cruise.mjs src bin test configs types --output-type err-html --config configs/.dependency-cruiser-show-metrics-config.mjs --output-to - | browser",
-    "depcruise:focus": "node ./bin/dependency-cruise.mjs src bin test configs types tools --progress --no-cache --output-type text --focus",
-    "depcruise:reaches": "node ./bin/dependency-cruise.mjs src bin test configs types tools --progress --no-cache --config configs/.dependency-cruiser-unlimited.mjs --output-type text --reaches",
-    "format": "prettier --log-level warn --write \"src/**/*.js\" \"configs/**/*.js\" \"tools/**/*.mjs\" \"bin/*\" \"types/*.d.mts\" \"test/**/*.spec.{cjs,js}\" \"test/**/*.{spec,utl}.mjs\"",
-    "format:check": "prettier --log-level warn --check \"src/**/*.js\" \"configs/**/*.js\" \"tools/**/*.mjs\" \"bin/*\" \"types/*.d.mts\" \"test/**/*.spec.{cjs,js}\" \"test/**/*.{spec,utl}.mjs\"",
-    "lint": "npm-run-all --parallel --aggregate-output lint:eslint format:check lint:types",
-    "lint:eslint": "eslint bin/dependency-cruise.mjs bin src test configs tools/**/*.mjs --cache --cache-location node_modules/.cache/eslint/",
-    "lint:eslint:fix": "eslint --fix bin src test configs tools/**/*.mjs --cache --cache-location node_modules/.cache/eslint/",
-    "lint:eslint:clear-caches": "rm -rf node_modules/.cache/eslint/",
-    "lint:fix": "npm-run-all lint:eslint:fix format lint:types:fix",
-    "lint:types": "npm-run-all lint:types:tsc lint:types:lint",
-    "lint:types:tsc": "tsc --project types/tsconfig.json",
-    "lint:types:lint": "eslint --no-ignore --config types/.eslintrc.json types/*.d.mts",
-    "lint:types:fix": "eslint --no-ignore --config types/.eslintrc.json --fix types/*.d.mts",
-    "prepare": "husky install",
-    "scm:push": "run-p --aggregate-output scm:push:*",
-    "scm:push:bitbucket-mirror": "run-p --aggregate-output scm:push:bitbucket-mirror:*",
-    "scm:push:bitbucket-mirror:commits": "git push bitbucket-mirror",
-    "scm:push:bitbucket-mirror:tags": "git push --tags bitbucket-mirror",
-    "scm:push:github": "run-p --aggregate-output scm:push:github:*",
-    "scm:push:github:commits": "git push",
-    "scm:push:github:tags": "git push --tags",
-    "scm:push:gitlab-mirror": "run-p --aggregate-output scm:push:gitlab-mirror:*",
-    "scm:push:gitlab-mirror:commits": "git push gitlab-mirror",
-    "scm:push:gitlab-mirror:tags": "git push --tags gitlab-mirror",
-    "scm:stage": "git add .",
-    "test": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha",
-    "test:i": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha --grep \"^\\[[I]\\]\"",
-    "test:u": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha --grep \"^\\[[U]\\]\"",
-    "test:e": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings mocha --grep \"^\\[[E]\\]\"",
-    "test:cover": "LANG=en_US.UTF-8 NODE_OPTIONS=--no-warnings c8 mocha",
-    "test:glob": "set -f && test \"`bin/dependency-cruise.mjs --no-config test/extract/__mocks__/gather-globbing/packages/**/src/**/*.js | grep \"no dependency violations found\"`\" = \"✔ no dependency violations found (6 modules, 0 dependencies cruised)\"",
-    "test:load": "hyperfine --warmup 3 --runs 30 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --no-cache --no-progress\"",
-    "test:load:short": "hyperfine --warmup 1 --runs 5 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --no-cache --no-progress\"",
-    "test:load:cached": "hyperfine --warmup 3 --runs 30 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --cache node_modules/.cache/dependency-cruiser/load-cached --no-progress\"",
-    "test:load:cached:short": "hyperfine --warmup 1 --runs 5 \"bin/dependency-cruise.mjs src bin test configs types tools --ignore-known --cache node_modules/.cache/dependency-cruiser/load-cached --no-progress\"",
-    "update-dependencies": "npm-run-all upem:update upem:install build:clean build lint:eslint:clear-caches lint:fix depcruise test:cover",
-    "upem-outdated": "npm outdated --json --long | upem --dry-run",
-    "upem:install": "npm install",
-    "upem:update": "npm outdated --json --long | upem | pbcopy && pbpaste",
-    "version": "npm-run-all build depcruise:graph:doc scm:stage"
-  },
   "dependencies": {
-    "acorn": "8.11.2",
+    "acorn": "8.11.3",
     "acorn-jsx": "5.3.2",
     "acorn-jsx-walk": "2.0.0",
     "acorn-loose": "8.4.0",
-    "acorn-walk": "8.3.1",
+    "acorn-walk": "8.3.2",
     "ajv": "8.12.0",
     "chalk": "5.3.0",
     "commander": "11.1.0",
@@ -187,48 +123,9 @@
     "semver-try-require": "6.2.3",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.1.0",
-    "watskeburt": "2.0.4",
+    "watskeburt": "2.0.5",
     "wrap-ansi": "9.0.0"
   },
-  "devDependencies": {
-    "@babel/core": "7.23.6",
-    "@babel/plugin-transform-modules-commonjs": "7.23.3",
-    "@babel/preset-typescript": "7.23.3",
-    "@swc/core": "1.3.101",
-    "@types/lodash": "4.14.202",
-    "@types/node": "20.10.5",
-    "@types/prompts": "2.4.9",
-    "@typescript-eslint/eslint-plugin": "6.16.0",
-    "@typescript-eslint/parser": "6.16.0",
-    "@vue/compiler-sfc": "3.3.13",
-    "c8": "8.0.1",
-    "coffeescript": "2.7.0",
-    "eslint": "8.56.0",
-    "eslint-config-moving-meadow": "4.0.2",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-budapestian": "6.0.0",
-    "eslint-plugin-eslint-comments": "3.2.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-mocha": "10.2.0",
-    "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-security": "2.1.0",
-    "eslint-plugin-unicorn": "^50.0.1",
-    "husky": "8.0.3",
-    "intercept-stdout": "0.1.2",
-    "lint-staged": "15.2.0",
-    "mocha": "10.2.0",
-    "normalize-newline": "4.1.0",
-    "npm-run-all": "4.1.5",
-    "prettier": "3.1.1",
-    "proxyquire": "2.1.3",
-    "shx": "0.3.4",
-    "svelte": "3.59.1",
-    "symlink-dir": "5.2.1",
-    "typescript": "5.3.3",
-    "upem": "9.0.2",
-    "vue-template-compiler": "2.7.16",
-    "yarn": "1.22.21"
-  },
   "overrides": {
     "semver": "^7.5.4",
     "postcss": "^8.4.31"
@@ -237,37 +134,10 @@
     "semver": "^7.5.4",
     "postcss": "^8.4.31"
   },
-  "upem": {
-    "policies": [
-      {
-        "package": "interpret",
-        "policy": "wanted",
-        "because": "we want to keep interpret ~similar to what webpack-cli uses (which is ^3.1.1 since 2022-11-15). See https://github.com/webpack/webpack-cli/blame/master/packages/webpack-cli/package.json"
-      },
-      {
-        "package": "rechoir",
-        "policy": "wanted",
-        "because": "we want to keep rechoir ~similar to what webpack-cli uses (which is ^0.8.0 since 2022-11-15). See https://github.com/webpack/webpack-cli/blame/master/packages/webpack-cli/package.json"
-      },
-      {
-        "package": "svelte",
-        "policy": "pin",
-        "because": "upgrading to supporting svelte 4 will require a non-trivial amount of labour (which we are going to invest, but not right now)"
-      }
-    ]
-  },
   "engines": {
     "node": "^18.17||>=20"
   },
-  "supportedTranspilers": {
-    "babel": ">=7.0.0 <8.0.0",
-    "coffee-script": ">=1.0.0 <2.0.0",
-    "coffeescript": ">=1.0.0 <3.0.0",
-    "livescript": ">=1.0.0 <2.0.0",
-    "svelte": ">=3.0.0 <4.0.0",
-    "swc": ">=1.0.0 <2.0.0",
-    "typescript": ">=2.0.0 <6.0.0",
-    "vue-template-compiler": ">=2.0.0 <3.0.0",
-    "@vue/compiler-sfc": ">=3.0.0 <4.0.0"
+  "scripts": {
+    "test": "echo for test, build and static analysis scripts: see the github repository"
   }
 }

package/src/cli/index.mjs

@@ -138,16 +138,27 @@ async function runCruise(pFileDirectoryArray, pCruiseOptions) {
  *
  * @param {string[]} pFileDirectoryArray
  * @param {import("../../types/options.mjs").ICruiseOptions} lCruiseOptions
+ * @param {{stdout: NodeJS.WritableStream, stderr: NodeJS.WritableStream}=} pStreams
  * @returns {number}
  */
-export default async function executeCli(pFileDirectoryArray, pCruiseOptions) {
+// eslint-disable-next-line complexity
+export default async function executeCli(
+  pFileDirectoryArray,
+  pCruiseOptions,
+  pStreams,
+) {
+  const lStreams = {
+    stdout: process.stdout,
+    stderr: process.stderr,
+    ...(pStreams || {}),
+  };
   let lCruiseOptions = pCruiseOptions || {};
   let lExitCode = 0;
 
   try {
     /* c8 ignore start */
     if (isInstalledGlobally) {
-      process.stderr.write(
+      lStreams.stderr.write(
         `\n  ${chalk.yellow(
           "WARNING",
         )}: You're running a globally installed dependency-cruiser.\n\n` +
@@ -164,15 +175,15 @@ export default async function executeCli(pFileDirectoryArray, pCruiseOptions) {
       const { default: formatMetaInfo } = await import(
         "./format-meta-info.mjs"
       );
-      process.stdout.write(await formatMetaInfo());
+      lStreams.stdout.write(await formatMetaInfo());
     } else if (lCruiseOptions.init) {
       const { default: initConfig } = await import("./init-config/index.mjs");
-      initConfig(lCruiseOptions.init);
+      initConfig(lCruiseOptions.init, null, lStreams);
     } else {
       lExitCode = await runCruise(pFileDirectoryArray, lCruiseOptions);
     }
   } catch (pError) {
-    process.stderr.write(`\n  ${chalk.red("ERROR")}: ${pError.message}\n`);
+    lStreams.stderr.write(`\n  ${chalk.red("ERROR")}: ${pError.message}\n`);
     bus.emit("end");
     lExitCode = 1;
   }

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

@@ -330,7 +330,7 @@ module.exports = {
         If you have a 'conditionNames' attribute in your webpack config, that one will
         have precedence over the one specified here.
       */
-      conditionNames: ["import", "require", "node", "default"],
+      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

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

@@ -75,8 +75,14 @@ function manifestIsUpdatable(pNormalizedInitConfig) {
 /**
  * @param {boolean|import("./types").OneShotConfigIDType} pInit
  * @param {string=} pConfigFileName
+ * @param {{stdout: NodeJS.WritableStream, stderr: NodeJS.WritableStream}=} pStreams
  */
-export default function initConfig(pInit, pConfigFileName) {
+export default function initConfig(pInit, pConfigFileName, pStreams) {
+  const lStreams = {
+    stdout: process.stdout,
+    stderr: process.stderr,
+    ...pStreams,
+  };
   /* c8 ignore start */
   if (pInit === true) {
     getUserInput()
@@ -84,19 +90,33 @@ export default function initConfig(pInit, pConfigFileName) {
       .then(buildConfig)
       .then(writeConfig)
       .catch((pError) => {
-        process.stderr.write(`\n  ERROR: ${pError.message}\n`);
+        lStreams.stderr.write(`\n  ERROR: ${pError.message}\n`);
       });
     /* c8 ignore stop */
   } else if (pInit !== false) {
     const lNormalizedInitConfig = normalizeInitOptions(getOneShotConfig(pInit));
     const lConfigFileName = pConfigFileName || getDefaultConfigFileName();
 
-    if (!fileExists(lConfigFileName)) {
-      writeConfig(buildConfig(lNormalizedInitConfig), lConfigFileName);
-    }
-
     if (manifestIsUpdatable(lNormalizedInitConfig)) {
-      writeRunScriptsToManifest(lNormalizedInitConfig);
+      // if we're going to update the manifest, no need to complain about
+      // a .dependency-cruiser that might already exist, because writing
+      // run scripts to the manifest could still work AOK.
+      if (!fileExists(lConfigFileName)) {
+        writeConfig(
+          buildConfig(lNormalizedInitConfig),
+          lConfigFileName,
+          lStreams.stdout,
+        );
+      }
+      writeRunScriptsToManifest(lNormalizedInitConfig, {
+        outStream: lStreams.stdout,
+      });
+    } else {
+      writeConfig(
+        buildConfig(lNormalizedInitConfig),
+        lConfigFileName,
+        lStreams.stdout,
+      );
     }
   }
 }

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

@@ -12,6 +12,7 @@ import {
  * @returns {void}  Nothing
  * @param  {string} pConfig - dependency-cruiser configuration
  * @param  {import("fs").PathOrFileDescriptor} pFileName - name of the file to write to
+ * @param  {NodeJS.WritableStream} pOutStream - the stream to write user feedback to
  * @throws {Error}  An error object with the root cause of the problem
  *                  as a description:
  *                  - file already exists
@@ -20,22 +21,23 @@ import {
  */
 export default function writeConfig(
   pConfig,
-  pFileName = getDefaultConfigFileName()
+  pFileName = getDefaultConfigFileName(),
+  pOutStream = process.stdout,
 ) {
   if (fileExists(pFileName)) {
     throw new Error(`A '${pFileName}' already exists here - leaving it be.\n`);
   } else {
     try {
       writeFileSync(pFileName, pConfig);
-      process.stdout.write(
+      pOutStream.write(
         `\n  ${chalk.green(
-          figures.tick
-        )} Successfully created '${pFileName}'\n\n`
+          figures.tick,
+        )} Successfully created '${pFileName}'\n\n`,
       );
       /* c8 ignore start */
     } catch (pError) {
       throw new Error(
-        `ERROR: Writing to '${pFileName}' didn't work. ${pError}\n`
+        `ERROR: Writing to '${pFileName}' didn't work. ${pError}\n`,
       );
     }
     /* c8 ignore stop */

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

@@ -131,21 +131,30 @@ function getSuccessMessage(pDestinationManifestFileName) {
   );
 }
 
-export function writeRunScriptsToManifest(
-  pNormalizedInitOptions,
-  pManifest = readManifest(),
-  pDestinationManifestFileName = PACKAGE_MANIFEST,
-) {
+/**
+ *
+ * @param {any} pNormalizedInitOptions
+ * @param {{manifest?: string, destinationManifestFileName?: string, outStream?: NodeJS.WritableStream}} pOptions
+ */
+export function writeRunScriptsToManifest(pNormalizedInitOptions, pOptions) {
+  const lOptions = {
+    manifest: readManifest(),
+    destinationManifestFileName: PACKAGE_MANIFEST,
+    outStream: process.stdout,
+    ...pOptions,
+  };
   const lUpdatedManifest = addRunScriptsToManifest(
-    pManifest,
+    lOptions.manifest,
     compileRunScripts(pNormalizedInitOptions),
   );
 
   writeFileSync(
-    pDestinationManifestFileName,
+    lOptions.destinationManifestFileName,
     JSON.stringify(lUpdatedManifest, null, "  "),
     "utf8",
   );
 
-  process.stdout.write(getSuccessMessage(pDestinationManifestFileName));
+  lOptions.outStream.write(
+    getSuccessMessage(lOptions.destinationManifestFileName),
+  );
 }

package/src/meta.js

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