fix(valid-types): disable checking of types/names within import t…

…ags; fixes #1226
gajus · May 9, 2024 · 4da4aeb · 4da4aeb
1 parent e343ab5
commit 4da4aeb
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/docs/rules/valid-types.md b/docs/rules/valid-types.md
@@ -880,5 +880,9 @@ function quux() {
 function quux() {
 
 }
+
+/**
+ * @import { TestOne, TestTwo } from "./types"
+ */
 ````
 
diff --git a/src/rules/validTypes.js b/src/rules/validTypes.js
@@ -212,6 +212,12 @@ export default iterateJsdoc(({
       continue;
     }
 
+    if (tag.tag === 'import') {
+      // A named import will look like a type, but not be valid; we also don't
+      //  need to check the name/namepath
+      continue;
+    }
+
     if (tag.tag === 'borrows') {
       const thisNamepath = /** @type {string} */ (
         utils.getTagDescription(tag)

diff --git a/test/rules/assertions/validTypes.js b/test/rules/assertions/validTypes.js
@@ -1853,5 +1853,12 @@ export default {
           }
       `
     },
+    {
+      code: `
+        /**
+         * @import { TestOne, TestTwo } from "./types"
+         */
+      `,
+    }
   ],
 };
-Original file line number
+Diff line change
@@ Expand Up / @@ -880,5 +880,9 @@ function quux() { @@
     function quux() {
     }
+    /**
+     * @import { TestOne, TestTwo } from "./types"
+     */
     ````