fix(imports-as-dependencies): check for types in package.json a…

…nd if not present, check `@types`; fixes #1107
gajus · Jun 3, 2023 · 785fb26 · 785fb26
1 parent d7ec6e0
commit 785fb26
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 6 deletions.
diff --git a/src/rules/importsAsDependencies.js b/src/rules/importsAsDependencies.js
@@ -37,6 +37,8 @@ try {
   /* eslint-enable no-console -- Inform user */
 }
 
+const moduleCheck = new Map();
+
 export default iterateJsdoc(({
   jsdoc,
   settings,
@@ -60,13 +62,34 @@ export default iterateJsdoc(({
     }
 
     traverse(typeAst, (nde) => {
-      if (nde.type === 'JsdocTypeImport' && !deps.has(nde.element.value.replace(
-        /^(@[^/]+\/[^/]+|[^/]+).*$/u, '$1',
-      ))) {
-        utils.reportJSDoc(
-          'import points to package which is not found in dependencies',
-          tag,
+      if (nde.type === 'JsdocTypeImport') {
+        let mod = nde.element.value.replace(
+          /^(@[^/]+\/[^/]+|[^/]+).*$/u, '$1',
         );
+        if (!moduleCheck.has(mod)) {
+          let pkg;
+          try {
+            pkg = JSON.parse(
+              // @ts-expect-error It's ok
+              readFileSync(join(process.cwd(), 'node_modules', mod, './package.json')),
+            );
+          } catch {
+            // Ignore
+          }
+
+          if (!pkg || !pkg.types) {
+            mod = `@types/${mod}`;
+          }
+
+          moduleCheck.set(mod, !deps.has(mod));
+        }
+
+        if (moduleCheck.get(mod)) {
+          utils.reportJSDoc(
+            'import points to package which is not found in dependencies',
+            tag,
+          );
+        }
       }
     });
   }

diff --git a/test/rules/assertions/importsAsDependencies.js b/test/rules/assertions/importsAsDependencies.js
@@ -87,5 +87,20 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @type {null|import('esquery').ESQueryOptions}
+         */
+      `,
+    },
+    {
+      code: `
+        /**
+         * @type {null|import('@es-joy/jsdoccomment').InlineTag|
+         *   import('@es-joy/jsdoccomment').JsdocBlock}
+         */
+      `,
+    },
   ],
 };