feat: add fixers to some rules (#54)

* hyphen POC

* added fixers to requireDescriptionCompleteSentence

* Added check that all sentences start with an uppercase letter, a fixer for it, and a test

* Added fixer for checktypes

* Added fixer to newlineAfterDescription

* removed unused function

* Fix eslint errors

* More ESlint fixes

Author: bary12

src/iterateJsdoc.js

@@ -63,18 +63,28 @@ export default (iterator) => {
         ]
       })[0] || {};
 
-      const report = (message) => {
-        context.report(jsdocNode, message);
+      const report = (message, fixer = null) => {
+        if (fixer === null) {
+          context.report(jsdocNode, message);
+        } else {
+          context.report({
+            fix: fixer,
+            message,
+            node: jsdocNode
+          });
+        }
       };
 
       const utils = curryUtils(functionNode, jsdoc, tagNamePreference, additionalTagNames);
 
       iterator({
         context,
         functionNode,
+        indent,
         jsdoc,
         jsdocNode,
         report,
+        sourceCode,
         utils
       });
     };

src/rules/checkTypes.js

@@ -42,6 +42,8 @@ const strictNativeTypes = [
 
 export default iterateJsdoc(({
   jsdoc,
+  jsdocNode,
+  sourceCode,
   report
 }) => {
   const jsdocTags = _.filter(jsdoc.tags, (tag) => {
@@ -51,7 +53,11 @@ export default iterateJsdoc(({
   _.forEach(jsdocTags, (jsdocTag) => {
     _.some(strictNativeTypes, (strictNativeType) => {
       if (strictNativeType.toLowerCase() === jsdocTag.type.toLowerCase() && strictNativeType !== jsdocTag.type) {
-        report('Invalid JSDoc @' + jsdocTag.tag + ' "' + jsdocTag.name + '" type "' + jsdocTag.type + '".');
+        const fix = (fixer) => {
+          return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace('{' + jsdocTag.type + '}', '{' + strictNativeType + '}'));
+        };
+
+        report('Invalid JSDoc @' + jsdocTag.tag + ' "' + jsdocTag.name + '" type "' + jsdocTag.type + '".', fix);
 
         return true;
       }

src/rules/newlineAfterDescription.js

@@ -4,7 +4,10 @@ import iterateJsdoc from '../iterateJsdoc';
 export default iterateJsdoc(({
   jsdoc,
   report,
-  context
+  context,
+  jsdocNode,
+  sourceCode,
+  indent
 }) => {
   let always;
 
@@ -25,9 +28,29 @@ export default iterateJsdoc(({
 
   if (always) {
     if (!descriptionEndsWithANewline) {
-      report('There must be a newline after the description of the JSDoc block.');
+      report('There must be a newline after the description of the JSDoc block.', (fixer) => {
+        const sourceLines = sourceCode.getText(jsdocNode).split('\n');
+        const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
+          return _.includes(line, _.last(jsdoc.description.split('\n')));
+        });
+
+        // Add the new line
+        sourceLines.splice(lastDescriptionLine + 1, 0, indent + ' * ');
+
+        return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
+      });
     }
   } else if (descriptionEndsWithANewline) {
-    report('There must be no newline after the description of the JSDoc block.');
+    report('There must be no newline after the description of the JSDoc block.', (fixer) => {
+      const sourceLines = sourceCode.getText(jsdocNode).split('\n');
+      const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
+        return _.includes(line, _.last(jsdoc.description.split('\n')));
+      });
+
+      // Remove the extra line
+      sourceLines.splice(lastDescriptionLine + 1, 1);
+
+      return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
+    });
   }
 });

src/rules/requireDescriptionCompleteSentence.js

@@ -5,6 +5,16 @@ const extractParagraphs = (text) => {
   return text.split(/\n\n/);
 };
 
+const extractSentences = (text) => {
+  return text.split(/\.\s*/).filter((sentence) => {
+    // Ignore sentences with only whitespaces.
+    return !/^\s*$/.test(sentence);
+  }).map((sentence) => {
+    // Re-add the dot.
+    return sentence + '.';
+  });
+};
+
 const isNewLinePrecededByAPeriod = (text) => {
   let lastLineEndsSentence;
 
@@ -25,26 +35,45 @@ const isCapitalized = (str) => {
   return str[0] === str[0].toUpperCase();
 };
 
-const validateDescription = (description, report) => {
+const capitalize = (str) => {
+  return str.charAt(0).toUpperCase() + str.slice(1);
+};
+
+const validateDescription = (description, report, jsdocNode, sourceCode) => {
   if (!description) {
     return false;
   }
 
   const paragraphs = extractParagraphs(description);
 
-  return _.some(paragraphs, (paragraph, index) => {
-    if (!isCapitalized(paragraph)) {
-      if (index === 0) {
-        report('Description must start with an uppercase character.');
-      } else {
-        report('Paragraph must start with an uppercase character.');
-      }
+  return _.some(paragraphs, (paragraph) => {
+    const sentences = extractSentences(paragraph);
 
-      return true;
+    if (_.some(sentences, (sentence) => {
+      return !isCapitalized(sentence);
+    })) {
+      report('Sentence should start with an uppercase character.', (fixer) => {
+        let text = sourceCode.getText(jsdocNode);
+
+        for (const sentence of sentences.filter((sentence_) => {
+          return !isCapitalized(sentence_);
+        })) {
+          const beginning = sentence.split(/\n/)[0];
+
+          text = text.replace(beginning, capitalize(beginning));
+        }
+
+        return fixer.replaceText(jsdocNode, text);
+      });
     }
 
     if (!/\.$/.test(paragraph)) {
-      report('Sentence must end with a period.');
+      report('Sentence must end with a period.', (fixer) => {
+        const line = _.last(paragraph.split('\n'));
+        const replacement = sourceCode.getText(jsdocNode).replace(line, line + '.');
+
+        return fixer.replaceText(jsdocNode, replacement);
+      });
 
       return true;
     }
@@ -60,10 +89,12 @@ const validateDescription = (description, report) => {
 };
 
 export default iterateJsdoc(({
+  sourceCode,
   jsdoc,
-  report
+  report,
+  jsdocNode
 }) => {
-  if (validateDescription(jsdoc.description, report)) {
+  if (validateDescription(jsdoc.description, report, jsdocNode, sourceCode)) {
     return;
   }
 
@@ -74,6 +105,6 @@ export default iterateJsdoc(({
   _.some(tags, (tag) => {
     const description = _.trimStart(tag.description, '- ');
 
-    return validateDescription(description, report);
+    return validateDescription(description, report, jsdocNode, sourceCode);
   });
 });

src/rules/requireHyphenBeforeParamDescription.js

@@ -2,16 +2,22 @@ import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
+  sourceCode,
   jsdoc,
-  report
+  report,
+  jsdocNode
 }) => {
   const jsdocTags = _.filter(jsdoc.tags, {
     tag: 'param'
   });
 
   _.forEach(jsdocTags, (jsdocTag) => {
     if (jsdocTag.description && !_.startsWith(jsdocTag.description, '-')) {
-      report('There must be a hyphen before @param description.');
+      report('There must be a hyphen before @param description.', (fixer) => {
+        const replacement = sourceCode.getText(jsdocNode).replace(jsdocTag.description, '- ' + jsdocTag.description);
+
+        return fixer.replaceText(jsdocNode, replacement);
+      });
     }
   });
 });

test/rules/assertions/checkTypes.js

@@ -15,7 +15,15 @@ export default {
         {
           message: 'Invalid JSDoc @param "foo" type "Number".'
         }
-      ]
+      ],
+      output: `
+          /**
+           * @param {number} foo
+           */
+          function quux (foo) {
+
+          }
+      `
     },
     {
       code: `
@@ -30,7 +38,15 @@ export default {
         {
           message: 'Invalid JSDoc @arg "foo" type "Number".'
         }
-      ]
+      ],
+      output: `
+          /**
+           * @arg {number} foo
+           */
+          function quux (foo) {
+
+          }
+      `
     }
   ],
   valid: [

test/rules/assertions/newlineAfterDescription.js

@@ -21,7 +21,19 @@ export default {
       ],
       options: [
         'always'
-      ]
+      ],
+      output: `
+          /**
+           * Foo.
+           *
+           * Foo.
+           * 
+           * @foo
+           */
+          function quux () {
+
+          }
+      `
     },
     {
       code: `
@@ -43,7 +55,18 @@ export default {
       ],
       options: [
         'never'
-      ]
+      ],
+      output: `
+          /**
+           * Bar.
+           *
+           * Bar.
+           * @bar
+           */
+          function quux () {
+
+          }
+      `
     }
   ],
   valid: [