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

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

Hide file tree

Showing 2 changed files with 30 additions and 6 deletions.
diff --git a/src/rules/importsAsDependencies.js b/src/rules/importsAsDependencies.js
@@ -60,13 +60,30 @@ 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',
         );
+        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}`;
+        }
+
+        if (!deps.has(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,12 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @type {null|import('esquery').ESQueryOptions}
+         */
+      `,
+    },
   ],
 };
-Original file line number
+Diff line change
@@ Expand Up / @@ -87,5 +87,12 @@ export default { @@
              */
           `,
         },
+        {
+          code: `
+            /**
+             * @type {null|import('esquery').ESQueryOptions}
+             */
+          `,
+        },
       ],
     };