fix(match-description, require-description-complete-sentence): do not…

… report blocking of tag by user for `description` tag (the tag is not required by these rules)
gajus · Jul 14, 2019 · 7102677 · 7102677
1 parent 135acd1
commit 7102677
Showing 1 changed file with 85 additions and 0 deletions.
diff --git a/test/rules/assertions/matchDescription.js b/test/rules/assertions/matchDescription.js
@@ -680,6 +680,57 @@ export default {
           ]
         }
       ]
+    },
+    {
+      code: `
+        /**
+         * @param foo Foo bar
+         */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'JSDoc description does not satisfy the regex pattern.'
+        }
+      ],
+      options: [{
+        tags: {
+          param: true
+        }
+      }],
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            description: false
+          }
+        }
+      }
+    },
+    {
+      code: `
+        /**
+         * Foo bar
+         */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'JSDoc description does not satisfy the regex pattern.'
+        }
+      ],
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            description: false
+          }
+        }
+      }
     }
   ],
   valid: [
@@ -1130,6 +1181,40 @@ export default {
           }
         }
       ]
+    },
+    {
+      code: `
+        /**
+         * @param foo Foo bar.
+         */
+        function quux (foo) {
+
+        }
+      `,
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            description: false
+          }
+        }
+      }
+    },
+    {
+      code: `
+        /**
+         *
+         */
+        function quux () {
+
+        }
+      `,
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            description: false
+          }
+        }
+      }
     }
   ]
 };