fix(require-description-complete-sentence): allow pipe symbol at beginning/end of sentences; fixes #423

Author: brettz9

README.md

@@ -4778,6 +4778,15 @@ function quux (foo) {
 * 1) The main Item;
 * 2) All its variants.
 */
+
+/**
+ * This method is working on 2 steps.
+ *
+ * | Step | Comment     |
+ * |------|-------------|
+ * |   1  | do it       |
+ * |   2  | do it again |
+ */
 ````
 
 

src/rules/requireDescriptionCompleteSentence.js

@@ -41,7 +41,7 @@ const isNewLinePrecededByAPeriod = (text) => {
       return true;
     }
 
-    lastLineEndsSentence = /[.:?!]$/u.test(line);
+    lastLineEndsSentence = /[.:?!|]$/u.test(line);
 
     return false;
   });
@@ -51,6 +51,10 @@ const isCapitalized = (str) => {
   return str[0] === str[0].toUpperCase();
 };
 
+const isTable = (str) => {
+  return str.charAt() === '|';
+};
+
 const capitalize = (str) => {
   return str.charAt(0).toUpperCase() + str.slice(1);
 };
@@ -75,7 +79,7 @@ const validateDescription = (description, reportOrig, jsdocNode, sourceCode, tag
       }
 
       for (const sentence of sentences.filter((sentence_) => {
-        return !(/^\s*$/u).test(sentence_) && !isCapitalized(sentence_);
+        return !(/^\s*$/u).test(sentence_) && !isCapitalized(sentence_) && !isTable(sentence_);
       })) {
         const beginning = sentence.split('\n')[0];
 
@@ -102,12 +106,12 @@ const validateDescription = (description, reportOrig, jsdocNode, sourceCode, tag
     };
 
     if (sentences.some((sentence) => {
-      return !(/^\s*$/u).test(sentence) && !isCapitalized(sentence);
+      return !(/^\s*$/u).test(sentence) && !isCapitalized(sentence) && !isTable(sentence);
     })) {
       report('Sentence should start with an uppercase character.', fix, tag);
     }
 
-    if (!/[.!?]$/u.test(paragraph)) {
+    if (!/[.!?|]$/u.test(paragraph)) {
       report('Sentence must end with a period.', fix, tag);
 
       return true;

test/rules/assertions/requireDescriptionCompleteSentence.js

@@ -897,5 +897,17 @@ export default {
       */
 `,
     },
+    {
+      code: `
+      /**
+       * This method is working on 2 steps.
+       *
+       * | Step | Comment     |
+       * |------|-------------|
+       * |   1  | do it       |
+       * |   2  | do it again |
+       */
+      `,
+    },
   ],
 };