fix: cover the edge cases in requireDescriptionCompleteSentence (#61)

* fix: Edge cases and tests for them

* revert unnecessary change

Author: bary12

src/rules/requireDescriptionCompleteSentence.js

@@ -33,7 +33,7 @@ const isNewLinePrecededByAPeriod = (text) => {
       return true;
     }
 
-    lastLineEndsSentence = /\.$/.test(line);
+    lastLineEndsSentence = /[.:?!]$/.test(line);
 
     return false;
   });
@@ -47,7 +47,7 @@ const capitalize = (str) => {
   return str.charAt(0).toUpperCase() + str.slice(1);
 };
 
-const validateDescription = (description, report, jsdocNode, sourceCode) => {
+const validateDescription = (description, report, jsdocNode, sourceCode, tag) => {
   if (!description) {
     return false;
   }
@@ -63,15 +63,23 @@ const validateDescription = (description, report, jsdocNode, sourceCode) => {
       if (!/[.:?!]$/.test(paragraph)) {
         const line = _.last(paragraph.split('\n'));
 
-        text = text.replace(line, line + '.');
+        text = text.replace(new RegExp(line + '$', 'm'), line + '.');
       }
 
       for (const sentence of sentences.filter((sentence_) => {
         return !isCapitalized(sentence_);
       })) {
         const beginning = sentence.split('\n')[0];
 
-        text = text.replace(beginning, capitalize(beginning));
+        if (tag) {
+          const reg = new RegExp('(@' + tag + '.*)' + _.escapeRegExp(beginning));
+
+          text = text.replace(reg, ($0, $1) => {
+            return $1 + capitalize(beginning);
+          });
+        } else {
+          text = text.replace(beginning, capitalize(beginning));
+        }
       }
 
       return fixer.replaceText(jsdocNode, text);
@@ -116,6 +124,6 @@ export default iterateJsdoc(({
   _.some(tags, (tag) => {
     const description = _.trimStart(tag.description, '- ');
 
-    return validateDescription(description, report, jsdocNode, sourceCode);
+    return validateDescription(description, report, jsdocNode, sourceCode, tag.tag);
   });
 });

test/rules/assertions/requireDescriptionCompleteSentence.js

@@ -356,6 +356,36 @@ export default {
            */
           function quux (foo) {
 
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * Returns bar.
+           * 
+           * @return {number} bar
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Sentence should start with an uppercase character.'
+        },
+        {
+          message: 'Sentence must end with a period.'
+        }
+      ],
+      output: `
+          /**
+           * Returns bar.
+           * 
+           * @return {number} Bar.
+           */
+          function quux (foo) {
+
           }
       `
     }
@@ -446,6 +476,16 @@ export default {
           }
       `
     },
+    {
+      code: `
+          /**
+           * Foo {@see Math.sin} bar.
+           */
+          function quux () {
+
+          }
+      `
+    },
     {
       code: `
           /**
@@ -459,6 +499,17 @@ export default {
            */
           function quux () {
 
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * Hello:
+           * World.
+           */
+          function quux () {
+
           }
       `
     }