fix(require-param): reporting all missing jsdoc params (#348)

fix('require-param'): report all missing jsdoc params (fixes #347)
gajus · Jul 20, 2019 · 6d34b94 · 6d34b94
1 parent fea6b88
commit 6d34b94
Show file tree

Hide file tree

Showing 3 changed files with 80 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -5774,6 +5774,30 @@ function quux (foo) {
 }
 // Message: Missing JSDoc @param "foo" declaration.
 
+/**
+ *
+ */
+function quux (foo, bar) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @param bar
+ */
+function quux (foo, bar, baz) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
+/**
+ * @param baz
+ */
+function quux (foo, bar, baz) {
+
+}
+// Message: Missing JSDoc @param "foo" declaration.
+
 /**
  * @param
  */

diff --git a/src/rules/requireParam.js b/src/rules/requireParam.js
@@ -20,16 +20,10 @@ export default iterateJsdoc(({
     return;
   }
 
-  functionParameterNames.some((functionParameterName, index) => {
-    const jsdocParameterName = jsdocParameterNames[index];
-
-    if (!jsdocParameterName) {
+  functionParameterNames.forEach((functionParameterName) => {
+    if (!jsdocParameterNames.includes(functionParameterName)) {
       report(`Missing JSDoc @${utils.getPreferredTagName({tagName: 'param'})} "${functionParameterName}" declaration.`);
-
-      return true;
     }
-
-    return false;
   });
 }, {
   meta: {

diff --git a/test/rules/assertions/requireParam.js b/test/rules/assertions/requireParam.js
@@ -21,6 +21,60 @@ export default {
         }
       ]
     },
+    {
+      code: `
+          /**
+           *
+           */
+          function quux (foo, bar) {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc @param "foo" declaration.'
+        },
+        {
+          message: 'Missing JSDoc @param "bar" declaration.'
+        }
+      ]
+    },
+    {
+      code: `
+          /**
+           * @param bar
+           */
+          function quux (foo, bar, baz) {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc @param "foo" declaration.'
+        },
+        {
+          message: 'Missing JSDoc @param "baz" declaration.'
+        }
+      ]
+    },
+    {
+      code: `
+          /**
+           * @param baz
+           */
+          function quux (foo, bar, baz) {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc @param "foo" declaration.'
+        },
+        {
+          message: 'Missing JSDoc @param "bar" declaration.'
+        }
+      ]
+    },
     {
       code: `
           /**