fix: ensure TSDeclareFunction is checked by default where function …

…contexts are expected; closes #897
gajus · Aug 8, 2022 · 25d2a7f · 25d2a7f
1 parent 4f8d242
commit 25d2a7f
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -3280,6 +3280,12 @@ function quux (foo) {
 }
 // "jsdoc/check-param-names": ["error"|"warn", {"enableFixer":true}]
 // Message: Duplicate @param "foo"
+
+/**
+ * @param barr This is the description of bar. Oops, we misspelled "bar" as "barr".
+ */
+declare function foo(bar: number) {}
+// Message: Expected @param names to be "bar". Got "barr".
 ````
 
 The following patterns are not considered problems:

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -1353,6 +1353,7 @@ export default function iterateJsdoc (iterator, ruleConfig) {
           'ArrowFunctionExpression',
           'FunctionDeclaration',
           'FunctionExpression',
+          'TSDeclareFunction',
         ]) {
           contextObject[prop] = checkJsdoc.bind(null, {
             selector: prop,

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -973,6 +973,7 @@ const enforcedContexts = (context, defaultContexts) => {
       'ArrowFunctionExpression',
       'FunctionDeclaration',
       'FunctionExpression',
+      'TSDeclareFunction',
     ] : defaultContexts,
   } = context.options[0] || {};
 

diff --git a/test/rules/assertions/checkParamNames.js b/test/rules/assertions/checkParamNames.js
@@ -1162,6 +1162,21 @@ export default {
           }
       `,
     },
+    {
+      code: `
+      /**
+       * @param barr This is the description of bar. Oops, we misspelled "bar" as "barr".
+       */
+      declare function foo(bar: number) {}
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Expected @param names to be "bar". Got "barr".',
+        },
+      ],
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
   valid: [
     {