fix(require-description): only report blocking of description tag by …

…user if "tag" option is set
gajus · Jul 14, 2019 · 135acd1 · 135acd1
1 parent b28a407
commit 135acd1
Showing 1 changed file with 63 additions and 0 deletions.
diff --git a/test/rules/assertions/requireDescriptionCompleteSentence.js b/test/rules/assertions/requireDescriptionCompleteSentence.js
@@ -567,6 +567,32 @@ export default {
           tags: ['see']
         }
       ]
+    },
+    {
+      code: `
+        /**
+         * @param foo Foo bar
+         */
+        function quux (foo) {
+
+        }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Sentence must end with a period.'
+        }
+      ],
+      options: [{
+        tags: ['param']
+      }],
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            description: false
+          }
+        }
+      }
     }
   ],
   valid: [
@@ -823,6 +849,43 @@ export default {
           tags: ['param']
         }
       ]
+    },
+    {
+      code: `
+        /**
+         * @param foo Foo bar.
+         */
+        function quux (foo) {
+
+        }
+      `,
+      options: [{
+        tags: ['param']
+      }],
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            description: false
+          }
+        }
+      }
+    },
+    {
+      code: `
+        /**
+         *
+         */
+        function quux (foo) {
+
+        }
+      `,
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            description: false
+          }
+        }
+      }
     }
   ]
 };