docs(match-description): more endLine tests

gajus · Mar 16, 2022 · 3bade86 · 3bade86
1 parent 9a3f70e
commit 3bade86
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7178,6 +7178,11 @@ function quux () {
  */
 // "jsdoc/match-description": ["error"|"warn", {"contexts":["any"],"matchDescription":"^\\S[\\s\\S]*\\S$"}]
 // Message: JSDoc description does not satisfy the regex pattern.
+
+/** Does something very important. */
+function foo(): string;
+// "jsdoc/match-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[endLine=0]"}],"matchDescription":"^\\S[\\s\\S]*\\S$"}]
+// Message: JSDoc description does not satisfy the regex pattern.
 ````
 
 The following patterns are not considered problems:
@@ -7537,6 +7542,14 @@ function quux () {
 /** Does something very important. */
 function foo(): string;
 // "jsdoc/match-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[endLine!=0]"}],"matchDescription":"^\\S[\\s\\S]*\\S$"}]
+
+/**
+ * This is my favorite function, foo.
+ *
+ * @returns Nothing.
+ */
+function foo(): void;
+// "jsdoc/match-description": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[endLine!=0]:not(:has(JsdocTag))"}],"matchDescription":"^\\S[\\s\\S]*\\S$"}]
 ````
 
 

diff --git a/test/rules/assertions/matchDescription.js b/test/rules/assertions/matchDescription.js
@@ -978,6 +978,29 @@ export default {
         },
       ],
     },
+    {
+      code: `
+        /** Does something very important. */
+        function foo(): string;
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'JSDoc description does not satisfy the regex pattern.',
+        },
+      ],
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock[endLine=0]',
+            },
+          ],
+          matchDescription: '^\\S[\\s\\S]*\\S$',
+        },
+      ],
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
   valid: [
     {
@@ -1653,5 +1676,26 @@ export default {
       ],
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+        /**
+         * This is my favorite function, foo.
+         *
+         * @returns Nothing.
+         */
+        function foo(): void;
+      `,
+      options: [
+        {
+          contexts: [
+            {
+              comment: 'JsdocBlock[endLine!=0]:not(:has(JsdocTag))',
+            },
+          ],
+          matchDescription: '^\\S[\\s\\S]*\\S$',
+        },
+      ],
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
 };