dependency-cruiser 16.7.0-beta-2 → 16.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-cruiser",
-  "version": "16.7.0-beta-2",
+  "version": "16.7.0",
   "description": "Validate and visualize dependencies. With your rules. JavaScript, TypeScript, CoffeeScript. ES6, CommonJS, AMD.",
   "keywords": [
     "static analysis",

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

@@ -62,6 +62,17 @@ function buildTsPreCompilationDepsAttribute(pInitOptions) {
     : "// tsPreCompilationDeps: false,";
 }
 
+/**
+ *
+ * @param {IInitConfig} pInitOptions
+ * @returns {string}
+ */
+function buildDetectJSDocumentImportsAttribute(pInitOptions) {
+  return pInitOptions.detectJSDocImports
+    ? "detectJSDocImports: true,"
+    : "// detectJSDocImports: true,";
+}
+
 /**
  * @param {IInitConfig} pInitOptions
  * @returns {string}
@@ -168,6 +179,10 @@ export default function buildConfig(pInitOptions) {
       extensionsToString(pInitOptions.resolutionExtensions),
     )
     .replace("{{notToTestRule}}", buildNotToTestRule(pInitOptions))
+    .replace(
+      "{{detectJSDocImportsAttribute}}",
+      buildDetectJSDocumentImportsAttribute(pInitOptions),
+    )
     .replace(
       "{{tsPreCompilationDepsAttribute}}",
       buildTsPreCompilationDepsAttribute(pInitOptions),

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

@@ -229,7 +229,7 @@ module.exports = {
     // moduleSystems: ['cjs', 'es6'],
 
     /* 
-      false: don't look at JSDoc imports
+      false: don't look at JSDoc imports (the default)
       true: dependency-cruiser will detect dependencies in JSDoc-style
       import statements. Implies "parser": "tsc", so the dependency-cruiser
       will use the typescript parser for JavaScript files.
@@ -237,7 +237,7 @@ module.exports = {
       For this to work the typescript compiler will need to be installed in the
       same spot as you're running dependency-cruiser from.
      */
-    // detectJSDocImports: true,
+    {{detectJSDocImportsAttribute}}
 
     /* prefix for links in html and svg output (e.g. 'https://github.com/you/yourrepo/blob/main/'
        to open it on your online repo or \`vscode://file/$\{process.cwd()}/\` to 

package/src/cli/init-config/get-user-input.mjs

@@ -18,6 +18,7 @@ import {
   getWebpackConfigCandidates,
 } from "./environment-helpers.mjs";
 import { validateLocation } from "./validators.mjs";
+import { isAvailable as tscIsAvailable } from "#extract/tsc/parse.mjs";
 
 function toPromptChoice(pString) {
   return {
@@ -108,6 +109,12 @@ const QUESTIONS = [
     message: "Full path to your 'tsconfig.json",
     choices: getTSConfigCandidates().map(toPromptChoice),
   },
+  {
+    name: "detectJSDocImports",
+    type: () => (tscIsAvailable() ? "confirm" : false),
+    message: "Do you want to detect JSDoc imports as well (slower)?",
+    initial: false,
+  },
   {
     name: "tsPreCompilationDeps",
     type: (_, pAnswers) => (pAnswers.useTsConfig ? "confirm" : false),

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

@@ -43,6 +43,7 @@ function getOneShotConfig(pOneShotConfigId) {
     jsConfig: getJSConfigCandidates().shift(),
     useTsConfig: hasTSConfigCandidates(),
     tsConfig: getTSConfigCandidates().shift(),
+    detectJSDocImports: false,
     tsPreCompilationDeps: hasTSConfigCandidates(),
     useWebpackConfig: hasWebpackConfigCandidates(),
     webpackConfig: getWebpackConfigCandidates().shift(),

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

@@ -56,11 +56,6 @@ const EXPERIMENTAL_SCRIPT_DOC = [
       EOL +
       "      to stdout - in simple text",
   },
-  // {
-  //   name: "depcruise:text",
-  //   headline: "",
-  //   description: "",
-  // },
 ];
 
 /**

package/src/extract/resolve/resolve.mjs

@@ -2,17 +2,19 @@ import enhancedResolve from "enhanced-resolve";
 import { stripQueryParameters } from "../helpers.mjs";
 import pathToPosix from "#utl/path-to-posix.mjs";
 
-let gResolvers = {};
-let gInitialized = {};
+let gResolvers = new Map();
+let gInitialized = new Map();
 
 function init(pEHResolveOptions, pCachingContext) {
-  if (!gInitialized[pCachingContext] || pEHResolveOptions.bustTheCache) {
+  if (!gInitialized.get(pCachingContext) || pEHResolveOptions.bustTheCache) {
     // assuming the cached file system here
     pEHResolveOptions.fileSystem.purge();
-    gResolvers[pCachingContext] =
-      enhancedResolve.ResolverFactory.createResolver(pEHResolveOptions);
+    gResolvers.set(
+      pCachingContext,
+      enhancedResolve.ResolverFactory.createResolver(pEHResolveOptions),
+    );
     /* eslint security/detect-object-injection:0 */
-    gInitialized[pCachingContext] = true;
+    gInitialized.set(pCachingContext, true);
   }
 }
 
@@ -35,7 +37,7 @@ export function resolve(
   init(pResolveOptions, pCachingContext);
 
   return stripQueryParameters(
-    gResolvers[pCachingContext].resolveSync(
+    gResolvers.get(pCachingContext).resolveSync(
       {},
       // lookupStartPath
       pathToPosix(pFileDirectory),
@@ -46,6 +48,6 @@ export function resolve(
 }
 
 export function clearCache() {
-  gInitialized = {};
-  gResolvers = {};
+  gInitialized.clear();
+  gResolvers.clear();
 }

package/src/extract/tsc/extract-typescript-deps.mjs

@@ -1,3 +1,4 @@
+/* eslint-disable security/detect-object-injection */
 /* eslint-disable unicorn/prevent-abbreviations */
 /* eslint-disable max-lines */
 /* eslint-disable no-inline-comments */
@@ -263,7 +264,7 @@ function extractJSDocImportTags(pJSDocTags) {
     .filter(
       (pTag) =>
         pTag.tagName.escapedText === "import" &&
-        pTag.moduleSpecifier?.kind &&
+        pTag.moduleSpecifier &&
         typescript.SyntaxKind[pTag.moduleSpecifier.kind] === "StringLiteral" &&
         pTag.moduleSpecifier.text,
     )
@@ -275,26 +276,64 @@ function extractJSDocImportTags(pJSDocTags) {
     }));
 }
 
+function isJSDocImport(pTypeNode) {
+  // import('./hello.mjs') within jsdoc
+  return (
+    typescript.SyntaxKind[pTypeNode?.kind] === "LastTypeNode" &&
+    typescript.SyntaxKind[pTypeNode.argument?.kind] === "LiteralType" &&
+    typescript.SyntaxKind[pTypeNode.argument?.literal?.kind] ===
+      "StringLiteral" &&
+    pTypeNode.argument.literal.text
+  );
+}
+
+function keyInJSDocIsIgnorable(pKey) {
+  return [
+    "parent",
+    "pos",
+    "end",
+    "flags",
+    "emitNode",
+    "modifierFlagsCache",
+    "transformFlags",
+    "id",
+    "flowNode",
+    "symbol",
+    "original",
+  ].includes(pKey);
+}
+
+export function walkJSDoc(pObject, pCollection = new Set()) {
+  if (isJSDocImport(pObject)) {
+    pCollection.add(pObject.argument.literal.text);
+  } else if (Array.isArray(pObject)) {
+    pObject.forEach((pValue) => walkJSDoc(pValue, pCollection));
+  } else if (typeof pObject === "object") {
+    for (const lKey in pObject) {
+      if (!keyInJSDocIsIgnorable(lKey) && pObject[lKey]) {
+        walkJSDoc(pObject[lKey], pCollection);
+      }
+    }
+  }
+}
+
+export function getJSDocImports(pTagNode) {
+  const lCollection = new Set();
+  walkJSDoc(pTagNode, lCollection);
+  return Array.from(lCollection);
+}
+
 function extractJSDocBracketImports(pJSDocTags) {
+  // https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
   return pJSDocTags
     .filter(
       (pTag) =>
         pTag.tagName.escapedText !== "import" &&
-        /* c8 ignore start */
-        typescript.SyntaxKind[pTag.typeExpression?.kind ?? -1] ===
-          "FirstJSDocNode" &&
-        typescript.SyntaxKind[pTag.typeExpression.type?.kind ?? -1] ===
-          "LastTypeNode" &&
-        typescript.SyntaxKind[pTag.typeExpression.type.argument?.kind ?? -1] ===
-          "LiteralType" &&
-        typescript.SyntaxKind[
-          pTag.typeExpression.type.argument?.literal?.kind ?? -1
-        ] === "StringLiteral" &&
-        /* c8 ignore stop*/
-        pTag.typeExpression.type.argument.literal.text,
+        typescript.SyntaxKind[pTag.typeExpression?.kind] === "FirstJSDocNode",
     )
-    .map((pTag) => ({
-      module: pTag.typeExpression.type.argument.literal.text,
+    .flatMap((pTag) => getJSDocImports(pTag))
+    .map((pImportName) => ({
+      module: pImportName,
       moduleSystem: "es6",
       exoticallyRequired: false,
       dependencyTypes: ["type-only", "import", "jsdoc", "jsdoc-bracket-import"],
@@ -302,6 +341,7 @@ function extractJSDocBracketImports(pJSDocTags) {
 }
 
 function extractJSDocImports(pJSDocNodes) {
+  // https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#the-jsdoc-import-tag
   const lJSDocNodesWithTags = pJSDocNodes.filter(
     (pJSDocLine) => pJSDocLine.tags,
   );
@@ -371,14 +411,8 @@ function walk(pResult, pExoticRequireStrings, pDetectJSDocImports) {
       });
     }
 
-    // /** @import thing from './module' */
-    // /** @import {thing} from './module' */
-    // /** @import * as thing from './module' */
-    // see https://devblogs.microsoft.com/typescript/announcing-typescript-5-5/#the-jsdoc-import-tag
-    //
-    // TODO: all the kinds of tags that can have import statements as type declarations
-    //      (e.g. @type, @param, @returns, @typedef, @property, @prop, @arg, ...)
-    // https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html
+    // /** @import thing from './module' */ etc
+    // /** @type {import('module').thing}*/ etc
     if (pDetectJSDocImports && pASTNode.jsDoc) {
       const lJSDocImports = extractJSDocImports(pASTNode.jsDoc);
 

package/src/meta.cjs

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