fix(no-undefined-types): do not treat type parameters or their references as undefined; #1215 (#1553)

Author: brettz9

docs/rules/no-undefined-types.md

@@ -384,6 +384,29 @@ class Filler {
 /** @type {AnotherType} */
 // "jsdoc/no-undefined-types": ["error"|"warn", {"checkUsedTypedefs":true}]
 // Message: This typedef was not used within the file
+
+/** @typedef {'cwd'} */
+let MyOwnType1
+
+/**
+ * @param {`${MyOwnType1}-${string}`} tagName
+ * @param {CustomElementConstructor} component
+ */
+let defineCustomElement = (tagName, component) => {
+  customElements.define(tagName, component)
+}
+
+/** @typedef {string} */
+let MyOwnType2
+
+/**
+ * @param {<T extends unknown>(element: MyOwnType2) => T} callback
+ * @returns {void}
+ */
+let getValue = (callback) => {
+  callback(`hello`)
+}
+// Message: The type 'CustomElementConstructor' is undefined.
 ````
 
 

package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "@es-joy/jsdoccomment": "~0.68.1",
+    "@es-joy/jsdoccomment": "~0.69.0",
     "are-docs-informative": "^0.0.2",
     "comment-parser": "1.4.1",
     "debug": "^4.4.3",
@@ -58,7 +58,7 @@
     "glob": "^11.0.3",
     "globals": "^16.4.0",
     "husky": "^9.1.7",
-    "jsdoc-type-pratt-parser": "^6.3.3",
+    "jsdoc-type-pratt-parser": "^6.4.0",
     "json-schema": "^0.4.0",
     "json-schema-to-typescript": "^15.0.4",
     "lint-staged": "^16.2.3",

pnpm-lock.yaml

@@ -512,6 +512,25 @@ export default iterateJsdoc(({
         if (!allDefinedTypes.has(val) &&
           (!Array.isArray(structuredTypes) || !structuredTypes.includes(val))
         ) {
+          const parent =
+            /**
+             * @type {import('jsdoc-type-pratt-parser').RootResult & {
+             *   _parent?: import('jsdoc-type-pratt-parser').NonRootResult
+             * }}
+             */ (nde)._parent;
+          if (parent?.type === 'JsdocTypeTypeParameter') {
+            return;
+          }
+
+          if (parent?.type === 'JsdocTypeFunction' &&
+            /** @type {import('jsdoc-type-pratt-parser').FunctionResult} */
+            (parent)?.typeParameters?.some((typeParam) => {
+              return value === typeParam.name.value;
+            })
+          ) {
+            return;
+          }
+
           if (!disableReporting) {
             report(`The type '${val}' is undefined.`, null, tag);
           }

src/rules/noUndefinedTypes.js

@@ -670,6 +670,37 @@ export default /** @type {import('../index.js').TestCases} */ ({
         },
       ],
     },
+    {
+      code: `
+        /** @typedef {'cwd'} */
+        let MyOwnType1
+
+        /**
+         * @param {\`\${MyOwnType1}-\${string}\`} tagName
+         * @param {CustomElementConstructor} component
+         */
+        let defineCustomElement = (tagName, component) => {
+          customElements.define(tagName, component)
+        }
+
+        /** @typedef {string} */
+        let MyOwnType2
+
+        /**
+         * @param {<T extends unknown>(element: MyOwnType2) => T} callback
+         * @returns {void}
+         */
+        let getValue = (callback) => {
+          callback(\`hello\`)
+        }
+      `,
+      errors: [
+        {
+          line: 7,
+          message: 'The type \'CustomElementConstructor\' is undefined.',
+        },
+      ],
+    },
   ],
   valid: [
     {