test: example for inline link targeting

gajus · May 23, 2023 · d730290 · d730290
1 parent 30f62ed
commit d730290
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/rules/require-param.md b/docs/rules/require-param.md
@@ -1812,5 +1812,9 @@ function foo(this: T, bar: number): number {
   console.log(this.name);
   return bar;
 }
+
+/** {@link someOtherval} */
+function a (b) {}
+// "jsdoc/require-param": ["error"|"warn", {"contexts":[{"comment":"*:not(JsdocBlock:has(JsdocInlineTag[tag=link]))","context":"FunctionDeclaration"}]}]
 ````
 
diff --git a/test/rules/assertions/requireParam.js b/test/rules/assertions/requireParam.js
@@ -3525,5 +3525,21 @@ export default {
       `,
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+        /** {@link someOtherval} */
+        function a (b) {}
+      `,
+      options: [
+        {
+          contexts: [
+            {
+              comment: '*:not(JsdocBlock:has(JsdocInlineTag[tag=link]))',
+              context: 'FunctionDeclaration',
+            },
+          ],
+        },
+      ],
+    },
   ],
 };