dependency-cruiser 13.0.1 → 13.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "13.0.1",
+  "version": "13.0.3",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",
@@ -50,17 +50,20 @@
       "types": "./types/dependency-cruiser.d.ts"
     },
     "./config-utl/extract-babel-config": {
-      "import": "./src/config-utl/extract-babel-config.mjs"
+      "import": "./src/config-utl/extract-babel-config.mjs",
+      "types": "./types/extract-babel-config.d.ts"
     },
     "./config-utl/extract-depcruise-config": {
-      "import": "./src/config-utl/extract-depcruise-config/index.mjs"
+      "import": "./src/config-utl/extract-depcruise-config/index.mjs",
+      "types": "./types/extract-depcruise-config.d.ts"
     },
     "./config-utl/extract-ts-config": {
       "import": "./src/config-utl/extract-ts-config.mjs",
       "types": "./types/extract-ts-config.d.ts"
     },
     "./config-utl/extract-webpack-resolve-config": {
-      "import": "./src/config-utl/extract-webpack-resolve-config.mjs"
+      "import": "./src/config-utl/extract-webpack-resolve-config.mjs",
+      "types": "./types/extract-webpack-resolve-config.d.ts"
     },
     "./sample-reporter-plugin": "./configs/plugins/stats-reporter-plugin.js",
     "./sample-3d-reporter-plugin": "./configs/plugins/3d-reporter-plugin.js",
@@ -90,10 +93,10 @@
     "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 tmp_graph_deps.json --progress",
-    "depcruise:graph:doc:fmt-detail": "./bin/depcruise-fmt.mjs -T dot -f - 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 - 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 - 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: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 > overview.svg && cd -",
     "depcruise:graph:doc:samples": "sh tools/generate-samples.sh",
@@ -153,10 +156,9 @@
     "ajv": "8.12.0",
     "chalk": "5.2.0",
     "commander": "10.0.1",
-    "enhanced-resolve": "5.14.0",
+    "enhanced-resolve": "5.14.1",
     "figures": "5.0.0",
-    "get-stream": "^6.0.1",
-    "glob": "10.2.4",
+    "glob": "10.2.6",
     "handlebars": "4.7.7",
     "ignore": "5.2.4",
     "indent-string": "5.0.0",
@@ -171,25 +173,25 @@
     "semver-try-require": "6.2.2",
     "teamcity-service-messages": "0.1.14",
     "tsconfig-paths-webpack-plugin": "4.0.1",
-    "watskeburt": "0.11.2",
+    "watskeburt": "0.11.3",
     "wrap-ansi": "8.1.0"
   },
   "devDependencies": {
-    "@babel/core": "7.21.8",
+    "@babel/core": "7.22.1",
     "@babel/plugin-transform-modules-commonjs": "7.21.5",
     "@babel/preset-typescript": "7.21.5",
-    "@swc/core": "1.3.58",
-    "@types/lodash": "4.14.194",
-    "@types/node": "20.1.6",
+    "@swc/core": "1.3.62",
+    "@types/lodash": "4.14.195",
+    "@types/node": "20.2.5",
     "@types/prompts": "2.4.4",
-    "@typescript-eslint/eslint-plugin": "5.59.6",
-    "@typescript-eslint/parser": "5.59.6",
-    "@vue/compiler-sfc": "3.3.2",
-    "c8": "7.13.0",
+    "@typescript-eslint/eslint-plugin": "5.59.8",
+    "@typescript-eslint/parser": "5.59.8",
+    "@vue/compiler-sfc": "3.3.4",
+    "c8": "7.14.0",
     "chai": "4.3.7",
     "chai-json-schema": "1.5.1",
     "coffeescript": "2.7.0",
-    "eslint": "8.40.0",
+    "eslint": "8.42.0",
     "eslint-config-moving-meadow": "4.0.2",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-budapestian": "5.0.1",
@@ -210,7 +212,7 @@
     "shx": "0.3.4",
     "svelte": "3.59.1",
     "symlink-dir": "5.1.1",
-    "typescript": "5.0.4",
+    "typescript": "5.1.3",
     "upem": "7.3.2",
     "vue-template-compiler": "2.7.14",
     "yarn": "1.22.19"

package/src/cli/format.mjs

@@ -1,4 +1,3 @@
-import getStream from "get-stream";
 import _format from "../main/format.mjs";
 import validateFileExistence from "./utl/validate-file-existence.mjs";
 import normalizeOptions from "./normalize-cli-options.mjs";
@@ -8,7 +7,7 @@ import { getInStream, write } from "./utl/io.mjs";
  *
  * @param {string} pResultFile the name of the file with cruise results
  * @param {import("../../types/dependency-cruiser").IFormatOptions} pOptions
- * @returns {Number} an exitCode
+ * @returns {Promise<Number>} an exitCode
  */
 export default async function format(pResultFile, pOptions) {
   const lOptions = await normalizeOptions(pOptions);
@@ -17,10 +16,30 @@ export default async function format(pResultFile, pOptions) {
     validateFileExistence(pResultFile);
   }
 
-  const lResult = await getStream(getInStream(pResultFile));
+  return new Promise((pResolve, pReject) => {
+    let lInputAsString = "";
+    const lInStream = getInStream(pResultFile);
 
-  const lReportingResult = await _format(JSON.parse(lResult), lOptions);
+    lInStream
+      .on("data", (pChunk) => {
+        lInputAsString += pChunk;
+      })
+      .on(
+        "error",
+        /* c8 ignore start */
+        (pError) => {
+          pReject(pError);
+        }
+        /* c8 ignore stop */
+      )
+      .on("end", async () => {
+        const lReportingResult = await _format(
+          JSON.parse(lInputAsString),
+          lOptions
+        );
 
-  write(lOptions.outputTo, lReportingResult.output);
-  return lReportingResult.exitCode;
+        write(lOptions.outputTo, lReportingResult.output);
+        pResolve(lReportingResult.exitCode);
+      });
+  });
 }

package/src/config-utl/extract-babel-config.mjs

@@ -76,11 +76,11 @@ async function getConfig(pBabelConfigFileName) {
 /**
  * Reads the file with name `pBabelConfigFileName` and returns its parsed
  * contents as an object
- *x
+ *
  * Silently fails if a supported @babel/core version can't be found
  *
  * @param {string} pBabelConfigFileName
- * @return {any} babel config as an object
+ * @return {object} babel config as an object
  * @throws {Error} when the babel config has an unknown extension OR
  *                 when the babel config is invalid OR
  *                 when dependency-cruiser can't yet process it

package/src/config-utl/extract-ts-config.mjs

@@ -35,7 +35,7 @@ const FORMAT_DIAGNOSTICS_HOST = {
  *
  * @param {string} pTSConfigFileName
  * @return {import("typescript").ParsedCommandLine} tsconfig as an object
- * @throws {Error} when the tsconfig is invalid/ jas errors
+ * @throws {Error} when the tsconfig is invalid/ has errors
  * @throws {TypeError} when the tsconfig is unreadable
  */
 export default function extractTSConfig(pTSConfigFileName) {

package/src/extract/ast-extractors/extract-typescript-deps.mjs

@@ -2,6 +2,7 @@
 import tryImport from "semver-try-require";
 import meta from "../../meta.js";
 
+/** @type {import("typescript")} */
 const typescript = await tryImport(
   "typescript",
   meta.supportedTranspilers.typescript
@@ -120,13 +121,26 @@ function firstArgumentIsAString(pASTNode) {
 }
 
 function isRequireCallExpression(pASTNode) {
-  return (
+  if (
     typescript.SyntaxKind[pASTNode.kind] === "CallExpression" &&
-    pASTNode.expression &&
-    typescript.SyntaxKind[pASTNode.expression.originalKeywordKind] ===
-      "RequireKeyword" &&
-    firstArgumentIsAString(pASTNode)
-  );
+    pASTNode.expression
+  ) {
+    /*
+     * from typescript 5.0.0 the `originalKeywordKind` attribute is deprecated
+     * and from 5.2.0 it will be gone. However, in typescript < 5.0.0 (still used
+     * heavily IRL) it's the only way to get it - hence this test for the
+     * existence of the * identifierToKeywordKind function to remain backwards
+     * compatible
+     */
+    const lSyntaxKind = typescript.identifierToKeywordKind
+      ? typescript.SyntaxKind[
+          typescript.identifierToKeywordKind(pASTNode.expression)
+        ]
+      : /* c8 ignore next 1 */
+        typescript.SyntaxKind[pASTNode.expression.originalKeywordKind];
+    return lSyntaxKind === "RequireKeyword" && firstArgumentIsAString(pASTNode);
+  }
+  return false;
 }
 
 function isSingleExoticRequire(pASTNode, pString) {

package/src/meta.js

@@ -1,7 +1,7 @@
 /* generated - don't edit */
 
 module.exports = {
-  version: "13.0.1",
+  version: "13.0.3",
   engines: {
     node: "^16.14||>=18",
   },

package/types/extract-babel-config.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Reads the file with name `pBabelConfigFileName` and returns its parsed
+ * contents as an object
+ *x
+ * Silently fails if a supported @babel/core version can't be found
+ *
+ * @param pBabelConfigFileName
+ * @return babel config as an object
+ * @throws when the babel config has an unknown extension OR
+ *         when the babel config is invalid OR
+ *         when dependency-cruiser can't yet process it
+ */
+export default function extractBabelConfig(
+  pBabelConfigFileName: string
+): Promise<object>;
+
+// regarding the rather unspecific _object_ type - this is what's
+// currently specified on definitelyTyped for @babel/core:
+// https://github.com/DefinitelyTyped/DefinitelyTyped/blob/b93ba16b8e482e66f7a82c426096ae31e1311710/types/babel__core/index.d.ts#L614

package/types/extract-depcruise-config.d.ts

@@ -0,0 +1,24 @@
+import { ICruiseOptions } from "./options";
+
+/**
+ * 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)
+ *
+ * ```javascript
+ * const depcruiseConfig = extractDepcruiseConfig("./.dependency-cruiser.js")
+ * ```
+ *
+ * @param pConfigFileName
+ * @param pAlreadyVisited
+ * @param pBaseDirectory
+ * @return dependency-cruiser options
+ * @throws when the config is not valid (/ does not exist/ isn't readable)
+ */
+export default function extractDepcruiseConfig(
+  pConfigFileName: string,
+  pAlreadyVisited?: Set<string>,
+  pBaseDirectory?: string
+): Promise<ICruiseOptions>;

package/types/extract-ts-config.d.ts

@@ -1,5 +1,16 @@
 import { ParsedCommandLine } from "typescript";
 
+/**
+ * Reads the file with name `pTSConfigFileName` and returns its parsed
+ * contents as an object
+ *
+ * Silently fails if a supported version of the typescript compiler isn't available
+ *
+ * @param pTSConfigFileName
+ * @return tsconfig as an object
+ * @throws {Error} when the tsconfig is invalid/ has errors
+ * @throws {TypeError} when the tsconfig is unreadable
+ */
 export default function extractTSConfig(
   pTSConfigFileName: string
 ): ParsedCommandLine;

package/types/extract-webpack-resolve-config.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Reads the file with name `pWebpackConfigFilename` and (applying the
+ * environment `pEnvironment` and the arguments `pArguments` (which can
+ * either be a string or a keys-values object)) returns the resolve config
+ * from it as an object.
+ *
+ * @param pWebpackConfigFilename
+ * @param pEnvironment
+ * @param pArguments
+ * @return webpack resolve config as an object
+ * @throws when the webpack config isn't usable (e.g. because it
+ *         doesn't exist, or because it's invalid)
+ */
+export default function extractWebpackResolveConfig(
+  pWebpackConfigFilename: string,
+  pEnvironment?: string,
+  pArguments?: string | any
+): Promise<any>;