fix(check-param-names): report proper line numbers (fixes #48)

Author: brettz9

src/rules/checkParamNames.js

@@ -10,10 +10,11 @@ const validateParameterNames = (targetTagName : string, functionParameterNames :
   });
 
   return paramTags.some((tag, index) => {
-    if (paramTags.some((tg, idx) => {
+    const dupeTag = paramTags.find((tg, idx) => {
       return tg.name === tag.name && idx !== index;
-    })) {
-      report(`Duplicate @${targetTagName} "${tag.name}"`);
+    });
+    if (dupeTag) {
+      report(`Duplicate @${targetTagName} "${tag.name}"`, null, dupeTag);
 
       return true;
     }
@@ -52,15 +53,15 @@ const validateParameterNames = (targetTagName : string, functionParameterNames :
   });
 };
 
-const validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames : Array<string>, report : Function) => {
+const validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames : Array<string>, jsdoc, report : Function) => {
   let lastRealParameter;
 
-  return jsdocParameterNames.some((jsdocParameterName) => {
+  return jsdocParameterNames.some((jsdocParameterName, idx) => {
     const isPropertyPath = jsdocParameterName.includes('.');
 
     if (isPropertyPath) {
       if (!lastRealParameter) {
-        report(`@${targetTagName} path declaration ("${jsdocParameterName}") appears before any real parameter.`);
+        report(`@${targetTagName} path declaration ("${jsdocParameterName}") appears before any real parameter.`, null, jsdoc.tags[idx]);
 
         return true;
       }
@@ -74,7 +75,9 @@ const validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames
       if (pathRootNodeName !== lastRealParameter) {
         report(
           `@${targetTagName} path declaration ("${jsdocParameterName}") root node name ("${pathRootNodeName}") ` +
-          `does not match previous real parameter name ("${lastRealParameter}").`
+          `does not match previous real parameter name ("${lastRealParameter}").`,
+          null,
+          jsdoc.tags[idx]
         );
 
         return true;
@@ -104,7 +107,7 @@ export default iterateJsdoc(({
     return;
   }
 
-  validateParameterNamesDeep(targetTagName, jsdocParameterNamesDeep, report);
+  validateParameterNamesDeep(targetTagName, jsdocParameterNamesDeep, jsdoc, report);
 }, {
   meta: {
     type: 'suggestion'

test/rules/assertions/checkParamNames.js

@@ -33,6 +33,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected @arg names to be "foo". Got "Foo".'
         }
       ],
@@ -55,6 +56,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected @param names to be "foo". Got "Foo".'
         }
       ]
@@ -70,6 +72,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: '@param path declaration ("Foo.Bar") appears before any real parameter.'
         }
       ]
@@ -86,6 +89,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: '@param path declaration ("Foo.Bar") root node name ("Foo") does not match previous real parameter name ("foo").'
         }
       ]
@@ -103,6 +107,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected @param names to be "bar, foo". Got "foo, bar".'
         }
       ]
@@ -136,6 +141,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Duplicate @param "foo"'
         }
       ]
@@ -152,6 +158,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Duplicate @param "foo"'
         }
       ]
@@ -168,6 +175,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Duplicate @param "foo"'
         }
       ]
@@ -183,6 +191,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Expected @param names to be "property". Got "prop".'
         }
       ],
@@ -202,6 +211,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Unexpected tag `@param`'
         }
       ],