feat(no-types): add TSMethodSignature; fixes #1249

gajus · Jun 24, 2024 · 1aa3313 · 1aa3313
1 parent 5497b03
commit 1aa3313
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 1 deletion.
diff --git a/docs/rules/no-types.md b/docs/rules/no-types.md
@@ -129,6 +129,14 @@ function quux () {
 
 }
 // Message: Types are not permitted on @returns.
+
+export interface B {
+  /**
+   * @param {string} paramA
+   */
+  methodB(paramB: string): void
+}
+// Message: Types are not permitted on @param.
 ````
 
 

diff --git a/src/rules/noTypes.js b/src/rules/noTypes.js
@@ -31,7 +31,11 @@ export default iterateJsdoc(({
     }
   }
 }, {
-  contextDefaults: true,
+  contextDefaults: [
+    'ArrowFunctionExpression', 'FunctionDeclaration', 'FunctionExpression', 'TSDeclareFunction',
+    // Add this to above defaults
+    'TSMethodSignature'
+  ],
   meta: {
     docs: {
       description: 'This rule reports types being used on `@param` or `@returns`.',

diff --git a/test/rules/assertions/noTypes.js b/test/rules/assertions/noTypes.js
@@ -1,3 +1,5 @@
+import * as typescriptEslintParser from '@typescript-eslint/parser';
+
 export default {
   invalid: [
     {
@@ -226,6 +228,33 @@ export default {
           }
       `,
     },
+    {
+      code: `
+        export interface B {
+          /**
+           * @param {string} paramA
+           */
+          methodB(paramB: string): void
+        }
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Types are not permitted on @param.',
+        },
+      ],
+      languageOptions: {
+        parser: typescriptEslintParser
+      },
+      output: `
+        export interface B {
+          /**
+           * @param paramA
+           */
+          methodB(paramB: string): void
+        }
+      `,
+    }
   ],
   valid: [
     {