test(require-param): add test limiting function to those with @param

Also: - test(`match-name`): make non-matching Jsdoc AST pattern more realistic
gajus · Oct 22, 2022 · 64b1ead · 64b1ead
1 parent 87c1c2a
commit 64b1ead
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -8012,7 +8012,7 @@ class A {
  * @property opt_a
  * @param {Foo|Bar} opt_b
  */
-// "jsdoc/match-name": ["error"|"warn", {"match":[{"comment":"JsdocBlock > JsdocTag[tag=\"param\"] > JsdocTypeUnion[left.name=\"Bar\"]","disallowName":"/^opt_/i"}]}]
+// "jsdoc/match-name": ["error"|"warn", {"match":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"param\"]:has(JsdocTypeUnion:has(JsdocTypeName[value=\"Bar\"]:nth-child(1))))","disallowName":"/^opt_/i"}]}]
 ````
 
 
@@ -16264,6 +16264,14 @@ export function testFn1 ({ prop = { a: 1, b: 2 } }) {
 /** Foo. */
 function foo(a, b, c) {}
 // Message: Missing JSDoc @param "a" declaration.
+
+/**
+ * @param foo Some number.
+ * @param bar Some number.
+ */
+export function myPublicFunction(foo: number, bar: number, baz: number) {}
+// "jsdoc/require-param": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag[tag=\"param\"])","context":"FunctionDeclaration"}]}]
+// Message: Missing JSDoc @param "baz" declaration.
 ````
 
 The following patterns are not considered problems:

diff --git a/test/rules/assertions/matchName.js b/test/rules/assertions/matchName.js
@@ -511,7 +511,7 @@ export default {
         {
           match: [
             {
-              comment: 'JsdocBlock > JsdocTag[tag="param"] > JsdocTypeUnion[left.name="Bar"]',
+              comment: 'JsdocBlock:has(JsdocTag[tag="param"]:has(JsdocTypeUnion:has(JsdocTypeName[value="Bar"]:nth-child(1))))',
               disallowName: '/^opt_/i',
             },
           ],

diff --git a/test/rules/assertions/requireParam.js b/test/rules/assertions/requireParam.js
@@ -2375,6 +2375,39 @@ export default {
         function foo(a, b, c) {}
       `,
     },
+    {
+      code: `
+        /**
+         * @param foo Some number.
+         * @param bar Some number.
+         */
+        export function myPublicFunction(foo: number, bar: number, baz: number) {}
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc @param "baz" declaration.',
+        },
+      ],
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock:has(JsdocTag[tag="param"])',
+              context: 'FunctionDeclaration',
+            },
+          ],
+        },
+      ],
+      output: `
+        /**
+         * @param foo Some number.
+         * @param bar Some number.
+         * @param baz
+         */
+        export function myPublicFunction(foo: number, bar: number, baz: number) {}
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
   valid: [
     {