fix(check-param-names): provide fixer duplicate param names (remove extra); partial fix for #47

Author: brettz9

src/iterateJsdoc.js

@@ -1,5 +1,6 @@
+// eslint-disable-next-line import/no-named-default
+import {default as commentParser, stringify as commentStringify} from 'comment-parser';
 import _ from 'lodash';
-import commentParser from 'comment-parser';
 import jsdocUtils from './jsdocUtils';
 import getJSDocComment from './eslint/getJSDocComment';
 
@@ -77,6 +78,23 @@ const getUtils = (
 
   const utils = {};
 
+  utils.stringify = (tagBlock) => {
+    let indent = sourceCode.text.match(/^\n*([ \t]+)/);
+    /* istanbul ignore next */
+    indent = indent ? indent[1] + indent[1].charAt() : ' ';
+
+    return commentStringify([tagBlock], {indent}).slice(indent.length - 1);
+  };
+
+  utils.reportJSDoc = (msg, tag, handler) => {
+    report(msg, (fixer) => {
+      handler();
+      const replacement = utils.stringify(jsdoc);
+
+      return fixer.replaceText(jsdocNode, replacement);
+    }, tag);
+  };
+
   utils.getFunctionParameterNames = () => {
     return jsdocUtils.getFunctionParameterNames(node);
   };

src/rules/checkParamNames.js

@@ -1,20 +1,25 @@
 import iterateJsdoc from '../iterateJsdoc';
 
-const validateParameterNames = (targetTagName : string, functionParameterNames : Array<string>, jsdoc, report) => {
+const validateParameterNames = (targetTagName : string, functionParameterNames : Array<string>, jsdoc, jsdocNode, utils, report) => {
   if (!jsdoc || !jsdoc.tags) {
     return false;
   }
 
-  const paramTags = jsdoc.tags.filter((tag) => {
+  const paramTags = Object.entries(jsdoc.tags).filter(([, tag]) => {
     return tag.tag === targetTagName && !tag.name.includes('.');
   });
 
-  return paramTags.some((tag, index) => {
-    const dupeTag = paramTags.find((tg, idx) => {
+  return paramTags.some(([, tag], index) => {
+    let tagsIndex;
+    const dupeTagInfo = paramTags.find(([tgsIndex, tg], idx) => {
+      tagsIndex = tgsIndex;
+
       return tg.name === tag.name && idx !== index;
     });
-    if (dupeTag) {
-      report(`Duplicate @${targetTagName} "${tag.name}"`, null, dupeTag);
+    if (dupeTagInfo) {
+      utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], () => {
+        jsdoc.tags.splice(tagsIndex, 1);
+      });
 
       return true;
     }
@@ -36,7 +41,7 @@ const validateParameterNames = (targetTagName : string, functionParameterNames :
 
     if (functionParameterName !== tag.name) {
       const expectedNames = functionParameterNames.join(', ');
-      const actualNames = paramTags.map(({name}) => {
+      const actualNames = paramTags.map(([, {name}]) => {
         return name;
       }).join(', ');
 
@@ -92,6 +97,7 @@ const validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames
 
 export default iterateJsdoc(({
   jsdoc,
+  jsdocNode,
   report,
   utils
 }) => {
@@ -101,7 +107,7 @@ export default iterateJsdoc(({
     return;
   }
   const targetTagName = utils.getPreferredTagName({tagName: 'param'});
-  const isError = validateParameterNames(targetTagName, functionParameterNames, jsdoc, report);
+  const isError = validateParameterNames(targetTagName, functionParameterNames, jsdoc, jsdocNode, utils, report);
 
   if (isError) {
     return;
@@ -110,6 +116,7 @@ export default iterateJsdoc(({
   validateParameterNamesDeep(targetTagName, jsdocParameterNamesDeep, jsdoc, report);
 }, {
   meta: {
+    fixable: 'code',
     type: 'suggestion'
   }
 });

test/rules/assertions/checkParamNames.js

@@ -144,7 +144,15 @@ export default {
           line: 4,
           message: 'Duplicate @param "foo"'
         }
-      ]
+      ],
+      output: `
+          /**
+           * @param foo
+           */
+          function quux (foo) {
+
+          }
+      `
     },
     {
       code: `