test: demo disabling param tags with name props

gajus · Oct 27, 2022 · 36f6f9c · 36f6f9c
1 parent beb169c
commit 36f6f9c
Show file tree

Hide file tree

Showing 2 changed files with 63 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -14850,6 +14850,15 @@ function quux (foo) {
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"param":false}}}
 // Message: Unexpected tag `@param`
+
+/**
+ * @param foo
+ */
+function quux (foo) {
+
+}
+// "jsdoc/require-param-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag:not([name=props]))","context":"FunctionDeclaration"}]}]
+// Message: Missing JSDoc @param "foo" description.
 ````
 
 The following patterns are not considered problems:
@@ -14886,6 +14895,14 @@ function quux (foo) {
  * @callback
  * @param foo
  */
+
+/**
+ * @param props
+ */
+function quux (props) {
+
+}
+// "jsdoc/require-param-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock:has(JsdocTag:not([name=props]))","context":"FunctionDeclaration"}]}]
 ````
 
 

diff --git a/test/rules/assertions/requireParamDescription.js b/test/rules/assertions/requireParamDescription.js
@@ -127,6 +127,32 @@ export default {
         },
       },
     },
+    {
+      code: `
+          /**
+           * @param foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Missing JSDoc @param "foo" description.',
+        },
+      ],
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock:has(JsdocTag:not([name=props]))',
+              context: 'FunctionDeclaration',
+            },
+          ],
+        },
+      ],
+    },
   ],
   valid: [
     {
@@ -196,5 +222,25 @@ export default {
       `,
       ignoreReadme: true,
     },
+    {
+      code: `
+          /**
+           * @param props
+           */
+          function quux (props) {
+
+          }
+      `,
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock:has(JsdocTag:not([name=props]))',
+              context: 'FunctionDeclaration',
+            },
+          ],
+        },
+      ],
+    },
   ],
 };