fix(require-description-complete-sentence): let fixer work with question and exclamation marks at sentence end (fixes part of #16)

Author: brettz9

README.md

@@ -3542,6 +3542,14 @@ function quux () {
 }
 // Message: Sentence should start with an uppercase character.
 
+/**
+ * foo?
+ */
+function quux () {
+
+}
+// Message: Sentence should start with an uppercase character.
+
 /**
  * @description foo.
  */

package.json

@@ -10,7 +10,8 @@
     "escape-regex-string": "^1.0.6",
     "flat-map-polyfill": "^0.3.8",
     "jsdoctypeparser": "5.0.1",
-    "lodash": "^4.17.11"
+    "lodash": "^4.17.11",
+    "regextras": "^0.6.1"
   },
   "description": "JSDoc linting rules for ESLint.",
   "devDependencies": {

src/rules/requireDescriptionCompleteSentence.js

@@ -1,25 +1,29 @@
 import _ from 'lodash';
+import {RegExtras} from 'regextras/dist/main-umd';
 import iterateJsdoc from '../iterateJsdoc';
 
 const extractParagraphs = (text) => {
   return text.split(/\n\n/);
 };
 
 const extractSentences = (text) => {
-  return text
+  const txt = text
 
     // Remove all {} tags.
-    .replace(/\{[\s\S]*?\}\s*/g, '')
-    .split(/[.?!](?:\s+|$)/)
+    .replace(/\{[\s\S]*?\}\s*/g, '');
+
+  const sentenceEndGrouping = /([.?!])(?:\s+|$)/;
+  const puncts = RegExtras(sentenceEndGrouping).map(txt, (punct) => {
+    return punct;
+  });
 
-    // Ignore sentences with only whitespaces.
-    .filter((sentence) => {
-      return !/^\s*$/.test(sentence);
-    })
+  return txt
+
+    .split(/[.?!](?:\s+|$)/)
 
     // Re-add the dot.
-    .map((sentence) => {
-      return `${sentence}.`;
+    .map((sentence, idx) => {
+      return /^\s*$/.test(sentence) ? sentence : `${sentence}${puncts[idx] || ''}`;
     });
 };
 
@@ -67,7 +71,7 @@ const validateDescription = (description, report, jsdocNode, sourceCode, tag) =>
       }
 
       for (const sentence of sentences.filter((sentence_) => {
-        return !isCapitalized(sentence_);
+        return !(/^\s*$/).test(sentence_) && !isCapitalized(sentence_);
       })) {
         const beginning = sentence.split('\n')[0];
 
@@ -86,7 +90,7 @@ const validateDescription = (description, report, jsdocNode, sourceCode, tag) =>
     };
 
     if (sentences.some((sentence) => {
-      return !isCapitalized(sentence);
+      return !(/^\s*$/).test(sentence) && !isCapitalized(sentence);
     })) {
       report('Sentence should start with an uppercase character.', fix);
     }

test/rules/assertions/requireDescriptionCompleteSentence.js

@@ -23,6 +23,29 @@ export default {
           }
       `
     },
+    {
+      code: `
+          /**
+           * foo?
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Sentence should start with an uppercase character.'
+        }
+      ],
+      output: `
+          /**
+           * Foo?
+           */
+          function quux () {
+
+          }
+      `
+    },
     {
       code: `
           /**