fix(require-template): check TSDeclareFunction (including overloads) for templates; fixes #1462

Author: brettz9

.README/rules/require-template.md

@@ -3,7 +3,7 @@
 Checks to see that `@template` tags are present for any detected type
 parameters.
 
-Currently checks `ClassDeclaration`, `FunctionDeclaration`,
+Currently checks `ClassDeclaration`, `FunctionDeclaration`, `TSDeclareFunction`,
 `TSInterfaceDeclaration` or `TSTypeAliasDeclaration` such as:
 
 ```ts

docs/rules/require-template.md

@@ -5,7 +5,7 @@
 Checks to see that `@template` tags are present for any detected type
 parameters.
 
-Currently checks `ClassDeclaration`, `FunctionDeclaration`,
+Currently checks `ClassDeclaration`, `FunctionDeclaration`, `TSDeclareFunction`,
 `TSInterfaceDeclaration` or `TSTypeAliasDeclaration` such as:
 
 ```ts
@@ -221,6 +221,18 @@ export default class <NumType> {
  * @returns {[D, V | undefined]}
  */
 // Message: Missing @template D
+
+/**
+ * @param bar
+ * @param baz
+ * @returns
+ */
+function foo<T>(bar: T, baz: number): T;
+function foo<T>(bar: T, baz: boolean): T;
+function foo<T>(bar: T, baz: number | boolean): T {
+  return bar;
+}
+// Message: Missing @template T
 ````
 
 

src/rules/requireTemplate.js

@@ -42,6 +42,7 @@ export default iterateJsdoc(({
   /**
    * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|
    *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|
+   *   import('@typescript-eslint/types').TSESTree.TSDeclareFunction|
    *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|
    *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration
    */
@@ -79,6 +80,7 @@ export default iterateJsdoc(({
     switch (nde.type) {
       case 'ClassDeclaration':
       case 'FunctionDeclaration':
+      case 'TSDeclareFunction':
       case 'TSInterfaceDeclaration':
       case 'TSTypeAliasDeclaration':
         checkTypeParams(nde);
@@ -97,6 +99,7 @@ export default iterateJsdoc(({
         switch (nde.declaration?.type) {
           case 'ClassDeclaration':
           case 'FunctionDeclaration':
+          case 'TSDeclareFunction':
           case 'TSInterfaceDeclaration':
           case 'TSTypeAliasDeclaration':
             checkTypeParams(nde.declaration);

test/rules/assertions/requireTemplate.js

@@ -403,6 +403,29 @@ export default /** @type {import('../index.js').TestCases} */ ({
         },
       ],
     },
+    {
+      code: `
+        /**
+         * @param bar
+         * @param baz
+         * @returns
+         */
+        function foo<T>(bar: T, baz: number): T;
+        function foo<T>(bar: T, baz: boolean): T;
+        function foo<T>(bar: T, baz: number | boolean): T {
+          return bar;
+        }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing @template T',
+        },
+      ],
+      languageOptions: {
+        parser: typescriptEslintParser,
+      },
+    },
   ],
   valid: [
     {