fix(no-undefined-types): liberalize checks to reallow for unknown properties on imports and defined globals; fixes #1412 (#1413)

brettz9 · web-flow · commit a083c815ed23 · 2025-06-23T05:04:45.000+08:00
diff --git a/docs/rules/no-undefined-types.md b/docs/rules/no-undefined-types.md
@@ -919,5 +919,26 @@ class Foo {
     return "bar";
   }
 }
+
+/* globals SomeGlobal, AnotherGlobal */
+import * as Ably from "ably"
+import Testing, { another as Another, stillMore as StillMore } from "testing"
+
+export class Code {
+    /** @type {Ably.Realtime} */
+    static #client
+
+    /** @type {Testing.SomeMethod} */
+    static #test
+
+    /** @type {Another.AnotherMethod} */
+    static #test2
+
+    /** @type {StillMore.AnotherMethod} */
+    static #test3
+
+    /** @type {AnotherGlobal.AnotherMethod} */
+    static #test4
+}
 ````
 
diff --git a/src/rules/noUndefinedTypes.js b/src/rules/noUndefinedTypes.js
@@ -112,14 +112,22 @@ export default iterateJsdoc(({
       .filter(Boolean));
   }
 
-  const comments = sourceCode.getAllComments()
+  const allComments = sourceCode.getAllComments();
+  const comments = allComments
     .filter((comment) => {
       return (/^\*\s/u).test(comment.value);
     })
     .map((commentNode) => {
       return parseComment(commentNode, '');
     });
 
+  const globals = allComments
+    .filter((comment) => {
+      return (/^\s*globals/u).test(comment.value);
+    }).flatMap((commentNode) => {
+      return commentNode.value.replace(/^\s*globals/u, '').trim().split(/,\s*/u);
+    });
+
   const typedefDeclarations = comments
     .flatMap((doc) => {
       return doc.tags.filter(({
@@ -242,6 +250,12 @@ export default iterateJsdoc(({
     return result;
   };
 
+  /**
+   * We treat imports differently as we can't introspect their children.
+   * @type {string[]}
+   */
+  const imports = [];
+
   const allDefinedTypes = new Set(globalScope.variables.map(({
     name,
   }) => {
@@ -256,8 +270,22 @@ export default iterateJsdoc(({
         }) => {
           return variables;
         }).map(({
+          identifiers,
           name,
         }) => {
+          if (
+            [
+              'ImportDefaultSpecifier',
+              'ImportNamespaceSpecifier',
+              'ImportSpecifier',
+            ].includes(
+              /** @type {import('estree').Identifier & {parent: {type: string}}} */ (
+                identifiers?.[0])?.parent?.type,
+            )
+          ) {
+            imports.push(name);
+          }
+
           return name;
         /* c8 ignore next */
         }) : [],
@@ -408,7 +436,12 @@ export default iterateJsdoc(({
            *   _parent?: import('jsdoc-type-pratt-parser').NonRootResult
            * }}
            */ (currNode)._parent;
-        if (currNode && 'right' in currNode && currNode.right?.type === 'JsdocTypeProperty') {
+        if (
+          // Avoid appending for imports and globals since we don't want to
+          //  check their properties which may or may not exist
+          !imports.includes(val) && !globals.includes(val) &&
+          currNode && 'right' in currNode &&
+          currNode.right?.type === 'JsdocTypeProperty') {
           val = val + '.' + currNode.right.value;
         }
       } while (currNode?.type === 'JsdocTypeNamePath');
diff --git a/test/rules/assertions/noUndefinedTypes.js b/test/rules/assertions/noUndefinedTypes.js
@@ -1624,5 +1624,32 @@ export default /** @type {import('../index.js').TestCases} */ ({
         ecmaVersion: 2_022,
       },
     },
+    {
+      code: `
+        /* globals SomeGlobal, AnotherGlobal */
+        import * as Ably from "ably"
+        import Testing, { another as Another, stillMore as StillMore } from "testing"
+
+        export class Code {
+            /** @type {Ably.Realtime} */
+            static #client
+
+            /** @type {Testing.SomeMethod} */
+            static #test
+
+            /** @type {Another.AnotherMethod} */
+            static #test2
+
+            /** @type {StillMore.AnotherMethod} */
+            static #test3
+
+            /** @type {AnotherGlobal.AnotherMethod} */
+            static #test4
+        }
+      `,
+      languageOptions: {
+        parser: typescriptEslintParser,
+      },
+    },
   ],
 });
