docs(match-description): provide sample with catching leading white…

…space
gajus · Mar 11, 2022 · 13f128b · 13f128b
1 parent a31a8fd
commit 13f128b
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7161,6 +7161,16 @@ function quux () {
 }
 // "jsdoc/match-description": ["error"|"warn", {"matchDescription":"[\\s\\S]*\\S$"}]
 // Message: JSDoc description does not satisfy the regex pattern.
+
+/**
+ *
+ * This function does lots of things.
+ */
+ function quux () {
+
+ }
+// "jsdoc/match-description": ["error"|"warn", {"matchDescription":"^\\S[\\s\\S]*\\S$"}]
+// Message: JSDoc description does not satisfy the regex pattern.
 ````
 
 The following patterns are not considered problems:

diff --git a/test/rules/assertions/matchDescription.js b/test/rules/assertions/matchDescription.js
@@ -934,6 +934,28 @@ export default {
         },
       ],
     },
+    {
+      code: `
+         /**
+          *
+          * This function does lots of things.
+          */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'JSDoc description does not satisfy the regex pattern.',
+        },
+      ],
+      options: [
+        {
+          matchDescription: '^\\S[\\s\\S]*\\S$',
+        },
+      ],
+    },
   ],
   valid: [
     {