fix(require-description-complete-sentence): capture multiple newlin…

…es as "paragraphs"; fixes #1193
gajus · Jan 26, 2024 · c5f203a · c5f203a
1 parent 6b163c8
commit c5f203a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/docs/rules/require-description-complete-sentence.md b/docs/rules/require-description-complete-sentence.md
@@ -818,5 +818,16 @@ function quux () {
 }
 
 /** @param options {@link RequestOptions} specifying path parameters and query parameters. */
+
+/**
+ * A single line for testing.
+ *
+ * ```js
+ * const aCodeExample = true;
+ * ```
+ *
+ * @param parameter
+ */
+const code = (parameter) => 123;
 ````
 
diff --git a/src/rules/requireDescriptionCompleteSentence.js b/src/rules/requireDescriptionCompleteSentence.js
@@ -14,7 +14,7 @@ const otherDescriptiveTags = new Set([
  * @returns {string[]}
  */
 const extractParagraphs = (text) => {
-  return text.split(/(?<![;:])\n\n/u);
+  return text.split(/(?<![;:])\n\n+/u);
 };
 
 /**

diff --git a/test/rules/assertions/requireDescriptionCompleteSentence.js b/test/rules/assertions/requireDescriptionCompleteSentence.js
@@ -1577,5 +1577,19 @@ export default {
       /** @param options {@link RequestOptions} specifying path parameters and query parameters. */
       `,
     },
+    {
+      code: `
+        /**
+         * A single line for testing.
+         *
+         * \`\`\`js
+         * const aCodeExample = true;
+         * \`\`\`
+         *
+         * @param parameter
+         */
+        const code = (parameter) => 123;
+      `,
+    },
   ],
 };