feat(require-param): change fixer to fix all missing tags at once

gajus · Oct 18, 2019 · fc4d68e · fc4d68e
1 parent f174401
commit fc4d68e
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 17 deletions.
diff --git a/src/rules/requireParam.js b/src/rules/requireParam.js
@@ -18,39 +18,62 @@ export default iterateJsdoc(({
   if (utils.hasTag('type')) {
     return;
   }
-  const findExpectedIndex = (jsdocTags, funcParmOrder, tagName) => {
-    const docTags = jsdocTags.filter(({tag}) => {
-      return tag === tagName;
+
+  const preferredTagName = utils.getPreferredTagName({tagName: 'param'});
+
+  const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {
+    const functionTags = jsdocTags.filter(({tag}) => {
+      return tag === preferredTagName;
     });
     let expectedIndex = jsdocTags.length;
-    jsdocTags.forEach((tag, idx) => {
-      if (tag.tag === tagName) {
-        expectedIndex = docTags.indexOf(tag) < funcParmOrder ? idx + 1 : idx - 1;
+    jsdocTags.forEach((tag, index) => {
+      if (tag.tag === preferredTagName) {
+        expectedIndex = index;
+        if (functionTags.indexOf(tag) < indexAtFunctionParams) {
+          expectedIndex += 1;
+        }
       }
     });
 
     return expectedIndex;
   };
 
+  const missingTags = [];
+
   functionParameterNames.forEach((functionParameterName, functionParameterIdx) => {
     if (['<ObjectPattern>', '<ArrayPattern>'].includes(functionParameterName)) {
       return;
     }
     if (!jsdocParameterNames.includes(functionParameterName)) {
-      const preferredTagName = utils.getPreferredTagName({tagName: 'param'});
-      utils.reportJSDoc(`Missing JSDoc @${preferredTagName} "${functionParameterName}" declaration.`, null, () => {
-        if (!jsdoc.tags) {
-          jsdoc.tags = [];
-        }
-
-        const expectedIdx = findExpectedIndex(jsdoc.tags, functionParameterIdx, preferredTagName);
-        jsdoc.tags.splice(expectedIdx, 0, {
-          name: functionParameterName,
-          tag: preferredTagName,
-        });
+      missingTags.push({
+        functionParameterIdx,
+        functionParameterName,
       });
     }
   });
+
+  const fixAll = (missings, tags) => {
+    missings.forEach(({functionParameterIdx, functionParameterName}) => {
+      const expectedIdx = findExpectedIndex(tags, functionParameterIdx);
+      tags.splice(expectedIdx, 0, {
+        name: functionParameterName,
+        tag: preferredTagName,
+      });
+    });
+  };
+
+  missingTags.forEach(({functionParameterName}, index) => {
+    utils.reportJSDoc(`Missing JSDoc @${preferredTagName} "${functionParameterName}" declaration.`, null, () => {
+      if (!jsdoc.tags) {
+        jsdoc.tags = [];
+      }
+
+      // Fix all missing tags at the first time.
+      if (index === 0) {
+        fixAll(missingTags, jsdoc.tags);
+      }
+    });
+  });
 }, {
   meta: {
     fixable: true,

diff --git a/test/rules/assertions/requireParam.js b/test/rules/assertions/requireParam.js
@@ -49,6 +49,7 @@ export default {
       output: `
           /**
            * @param foo
+           * @param bar
            */
           function quux (foo, bar) {
 
@@ -100,6 +101,7 @@ export default {
           /**
            * @param foo
            * @param bar
+           * @param baz
            */
           function quux (foo, bar, baz) {
 
@@ -152,6 +154,7 @@ export default {
       output: `
           /**
            * @param foo
+           * @param bar
            * @param baz
            */
           function quux (foo, bar, baz) {