checkRedundantParams: fixed error with dotted params

Fixes #79

Author: qfox

lib/rules/validate-jsdoc/check-redundant-params.js

@@ -14,6 +14,8 @@ function validateCheckParamNames(node, err) {
         return;
     }
 
+    var skipped = 0;
+
     node.jsdoc.iterateByType(['param', 'arg', 'argument'],
         /**
          * tag checker
@@ -23,15 +25,23 @@ function validateCheckParamNames(node, err) {
         function(tag, i) {
             // skip if there is dot in param name (object's inner param)
             if (tag.name && tag.name.value.indexOf('.') !== -1) {
+                skipped++;
                 return;
             }
 
-            var param = node.params[i];
             var _optional = tag.optional || (tag.type && (tag.type.optional || tag.type.variable));
+            if (_optional) {
+                skipped++;
+                return;
+            }
+
+            var param = node.params[i - skipped];
 
             // checking redundant
-            if (!_optional && !param) {
-                return err('redundant param statement');
+            if (!param) {
+                return err('Found redundant ' +
+                    (tag.name ? 'param "' + tag.name.value + '"' : 'unnamed param') +
+                    ' statement', tag.loc);
             }
         });
 }

test/lib/rules/validate-jsdoc/check-redundant-params.js

@@ -115,6 +115,66 @@ describe('lib/rules/validate-jsdoc/check-redundant-params', function () {
                      */
                     function setTimeout(callback, delay) {}
                 }
+            }, {
+                // issue #79
+                it: 'should not report different names',
+                code: function() {
+                    /**
+                     * Example function
+                     * @param {Object} options - some options
+                     * @param {number} options.id - some id
+                     * @param {Array} rest - rest arguments
+                     */
+                    function hello(options, rest) {
+                        return (options.filename) ? true : false;
+                    }
+                },
+                errors: []
+            }, {
+                // issue #79
+                it: 'should report with right location',
+                code: function() {
+                    /**
+                     * @param {Object} options - some options
+                     * @param {Array} rest - rest arguments
+                     */
+                    function hello(options) {
+                    }
+                },
+                errors: [{
+                    column: 3, line: 3, filename: 'input', rule: 'jsDoc',
+                    message: 'Found redundant param "rest" statement'
+                }]
+            }, {
+                it: 'should not report optional params',
+                code: function() {
+                    /**
+                     * Example function
+                     * @param {Object} options - some options
+                     * @param {number} options.id - some id
+                     * @param {Go} [optional] - optional param
+                     * @param {Go=} optional2 - another optional param
+                     * @param {Array} rest - rest arguments
+                     */
+                    function hello(options, rest) {
+                    }
+                },
+                errors: []
+            }, {
+                it: 'should not report declared optional params',
+                code: function() {
+                    /**
+                     * Example function
+                     * @param {Object} options - some options
+                     * @param {number} options.id - some id
+                     * @param {Go} [optional] - optional param
+                     * @param {Go=} optional2 - another optional param
+                     * @param {Array} rest - rest arguments
+                     */
+                    function hello(options, optional, optional2, rest) {
+                    }
+                },
+                errors: []
             }
             /* jshint ignore:end */
         ]);