feat(require-template, check-template-names): add support `ClassD…

…eclaration`
gajus · Jul 30, 2024 · 31d3255 · 31d3255
1 parent 28bc1cb
commit 31d3255
Show file tree

Hide file tree

Showing 8 changed files with 447 additions and 8 deletions.
diff --git a/.README/rules/check-template-names.md b/.README/rules/check-template-names.md
@@ -3,8 +3,8 @@
 Checks that any `@template` names are actually used in the connected
 `@typedef` or type alias.
 
-Currently checks `FunctionDeclaration`, `TSInterfaceDeclaration` or
-`TSTypeAliasDeclaration` such as:
+Currently checks `ClassDeclaration`, `FunctionDeclaration`,
+`TSInterfaceDeclaration` or `TSTypeAliasDeclaration` such as:
 
 ```ts
 /**

diff --git a/.README/rules/require-template.md b/.README/rules/require-template.md
@@ -3,8 +3,8 @@
 Checks to see that `@template` tags are present for any detected type
 parameters.
 
-Currently checks `FunctionDeclaration`, `TSInterfaceDeclaration` or
-`TSTypeAliasDeclaration` such as:
+Currently checks `ClassDeclaration`, `FunctionDeclaration`,
+`TSInterfaceDeclaration` or `TSTypeAliasDeclaration` such as:
 
 ```ts
 export type Pairs<D, V> = [D, V | undefined];

diff --git a/docs/rules/check-template-names.md b/docs/rules/check-template-names.md
@@ -5,8 +5,8 @@
 Checks that any `@template` names are actually used in the connected
 `@typedef` or type alias.
 
-Currently checks `FunctionDeclaration`, `TSInterfaceDeclaration` or
-`TSTypeAliasDeclaration` such as:
+Currently checks `ClassDeclaration`, `FunctionDeclaration`,
+`TSInterfaceDeclaration` or `TSTypeAliasDeclaration` such as:
 
 ```ts
 /**
@@ -150,6 +150,46 @@ export default function identity<Type>(arg: Type): Type {
   return arg;
 }
 // Message: @template D not in use
+
+/**
+ * @template D
+ * @template V
+ */
+class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: @template D not in use
+
+/**
+ * @template D
+ * @template V
+ */
+export class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: @template D not in use
+
+/**
+ * @template D
+ * @template V
+ */
+export default class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: @template D not in use
+
+/**
+ * @template D
+ * @template V
+ */
+export default class <NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: @template D not in use
 ````
 
 
@@ -243,5 +283,37 @@ export function identity<Type>(arg: Type): Type {
 export default function identity<Type>(arg: Type): Type {
   return arg;
 }
+
+/**
+ * @template NumType
+ */
+class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+
+/**
+ * @template NumType
+ */
+export class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+
+/**
+ * @template NumType
+ */
+export default class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+
+/**
+ * @template NumType
+ */
+export default class <NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
 ````
 
diff --git a/docs/rules/require-template.md b/docs/rules/require-template.md
@@ -5,8 +5,8 @@
 Checks to see that `@template` tags are present for any detected type
 parameters.
 
-Currently checks `FunctionDeclaration`, `TSInterfaceDeclaration` or
-`TSTypeAliasDeclaration` such as:
+Currently checks `ClassDeclaration`, `FunctionDeclaration`,
+`TSInterfaceDeclaration` or `TSTypeAliasDeclaration` such as:
 
 ```ts
 export type Pairs<D, V> = [D, V | undefined];
@@ -163,6 +163,42 @@ export default function identity<Type>(arg: Type): Type {
   return arg;
 }
 // Message: Missing @template Type
+
+/**
+ *
+ */
+class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: Missing @template NumType
+
+/**
+ *
+ */
+export class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: Missing @template NumType
+
+/**
+ *
+ */
+export default class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: Missing @template NumType
+
+/**
+ *
+ */
+export default class <NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+// Message: Missing @template NumType
 ````
 
 
@@ -255,5 +291,37 @@ export function identity<Type>(arg: Type): Type {
 export default function identity<Type>(arg: Type): Type {
   return arg;
 }
+
+/**
+ * @template NumType
+ */
+class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+
+/**
+ * @template NumType
+ */
+export class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+
+/**
+ * @template NumType
+ */
+export default class GenericNumber<NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
+
+/**
+ * @template NumType
+ */
+export default class <NumType> {
+  zeroValue: NumType;
+  add: (x: NumType, y: NumType) => NumType;
+}
 ````
 
diff --git a/src/rules/checkTemplateNames.js b/src/rules/checkTemplateNames.js
@@ -21,6 +21,7 @@ export default iterateJsdoc(({
   const usedNames = new Set();
   /**
    * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|
+   *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|
    *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|
    *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration
    */
@@ -52,13 +53,15 @@ export default iterateJsdoc(({
     case 'ExportDefaultDeclaration':
     case 'ExportNamedDeclaration':
       switch (nde.declaration?.type) {
+        case 'ClassDeclaration':
         case 'FunctionDeclaration':
         case 'TSTypeAliasDeclaration':
         case 'TSInterfaceDeclaration':
           checkParameters(nde.declaration);
           break;
       }
       break;
+    case 'ClassDeclaration':
     case 'FunctionDeclaration':
     case 'TSTypeAliasDeclaration':
     case 'TSInterfaceDeclaration':

diff --git a/src/rules/requireTemplate.js b/src/rules/requireTemplate.js
@@ -36,6 +36,7 @@ export default iterateJsdoc(({
 
   /**
    * @param {import('@typescript-eslint/types').TSESTree.FunctionDeclaration|
+   *   import('@typescript-eslint/types').TSESTree.ClassDeclaration|
    *   import('@typescript-eslint/types').TSESTree.TSInterfaceDeclaration|
    *   import('@typescript-eslint/types').TSESTree.TSTypeAliasDeclaration} aliasDeclaration
    */
@@ -62,6 +63,7 @@ export default iterateJsdoc(({
     switch (nde.type) {
     case 'ExportDefaultDeclaration':
       switch (nde.declaration?.type) {
+        case 'ClassDeclaration':
         case 'FunctionDeclaration':
         case 'TSInterfaceDeclaration':
           checkTypeParams(nde.declaration);
@@ -70,13 +72,15 @@ export default iterateJsdoc(({
       break;
     case 'ExportNamedDeclaration':
       switch (nde.declaration?.type) {
+      case 'ClassDeclaration':
       case 'FunctionDeclaration':
       case 'TSTypeAliasDeclaration':
       case 'TSInterfaceDeclaration':
         checkTypeParams(nde.declaration);
         break;
       }
       break;
+    case 'ClassDeclaration':
     case 'FunctionDeclaration':
     case 'TSTypeAliasDeclaration':
     case 'TSInterfaceDeclaration':