feat: add fixer to check-tag-names

Author: vulkd

src/rules/checkTagNames.js

@@ -2,16 +2,22 @@ import _ from 'lodash';
 import iterateJsdoc from '../iterateJsdoc';
 
 export default iterateJsdoc(({
+  sourceCode,
   jsdoc,
   report,
-  utils
+  utils,
+  jsdocNode
 }) => {
   _.forEach(jsdoc.tags, (jsdocTag) => {
     if (utils.isValidTag(jsdocTag.tag)) {
       const preferredTagName = utils.getPreferredTagName(jsdocTag.tag);
 
       if (preferredTagName !== jsdocTag.tag) {
-        report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".', null, jsdocTag);
+        report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".', (fixer) => {
+          const replacement = sourceCode.getText(jsdocNode).replace(jsdocTag.tag, preferredTagName);
+
+          return fixer.replaceText(jsdocNode, replacement);
+        });
       }
     } else {
       report('Invalid JSDoc tag name "' + jsdocTag.tag + '".', null, jsdocTag);

src/tagNames.js

@@ -71,7 +71,8 @@ export default {
   package: [],
   param: [
     'arg',
-    'argument'
+    'argument',
+    'parameter'
   ],
   private: [],
   property: [

test/rules/assertions/checkTagNames.js

@@ -47,7 +47,7 @@ export default {
       `,
       errors: [
         {
-          line: 3,
+          line: 2,
           message: 'Invalid JSDoc tag (preference). Replace "arg" JSDoc tag with "param".'
         }
       ]
@@ -63,7 +63,7 @@ export default {
       `,
       errors: [
         {
-          line: 3,
+          line: 2,
           message: 'Invalid JSDoc tag (preference). Replace "param" JSDoc tag with "arg".'
         }
       ],
@@ -75,6 +75,29 @@ export default {
         }
       }
     },
+    {
+      code: `
+          /**
+           * @param foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Invalid JSDoc tag (preference). Replace "param" JSDoc tag with "parameter".'
+        }
+      ],
+      settings: {
+        jsdoc: {
+          tagNamePreference: {
+            param: 'parameter'
+          }
+        }
+      }
+    },
     {
       code: `
           /**