fix(check-param-names): adjusts line numbers to be nearer problemat…

…ic item Also adds test line numbers.
gajus · May 14, 2021 · e6c9ab2 · e6c9ab2
1 parent a977896
commit e6c9ab2
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 3 deletions.
diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -39,6 +39,8 @@ const getBasicUtils = (context, {tagNamePreference, mode}) => {
     return jsdocUtils.parseClosureTemplateTag(tag);
   };
 
+  utils.pathDoesNotBeginWith = jsdocUtils.pathDoesNotBeginWith;
+
   utils.getPreferredTagNameObject = ({tagName}) => {
     const ret = jsdocUtils.getPreferredTagName(context, mode, tagName, tagNamePreference);
     const isObject = ret && typeof ret === 'object';

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -1219,6 +1219,11 @@ const comparePaths = (name) => {
   };
 };
 
+const pathDoesNotBeginWith = (name, otherPathName) => {
+  return !name.startsWith(otherPathName) &&
+    !dropPathSegmentQuotes(name).startsWith(dropPathSegmentQuotes(otherPathName));
+};
+
 const getRegexFromString = (regexString, requiredFlags) => {
   const match = regexString.match(/^\/(.*)\/([gimyus]*)$/us);
   let flags = 'u';
@@ -1266,6 +1271,7 @@ export default {
   isValidTag,
   overrideTagStructure,
   parseClosureTemplateTag,
+  pathDoesNotBeginWith,
   setTagStructure,
   tagMightHaveNamepath,
   tagMightHaveNamePosition,

diff --git a/src/rules/checkParamNames.js b/src/rules/checkParamNames.js
@@ -99,16 +99,25 @@ const validateParameterNames = (
           if (!checkRestProperty && rests[idx]) {
             return;
           }
-          missingProperties.push(name);
+          const missingIndex = actualNames.findIndex((actualName) => {
+            return utils.pathDoesNotBeginWith(name, actualName);
+          });
+          const line = tag.source[0].number - 1 + (missingIndex > -1 ? missingIndex : actualNames.length);
+          missingProperties.push({
+            name,
+            tagPlacement: {
+              line: line === 0 ? 1 : line,
+            },
+          });
         } else if (actualTypes[actualNameIdx].search(checkTypesRegex) === -1 && actualTypes[actualNameIdx] !== '') {
           notCheckingNames.push(name);
         }
       });
 
       const hasMissing = missingProperties.length;
       if (hasMissing) {
-        missingProperties.forEach((missingProperty) => {
-          report(`Missing @${targetTagName} "${missingProperty}"`, null, tag);
+        missingProperties.forEach(({tagPlacement, name: missingProperty}) => {
+          report(`Missing @${targetTagName} "${missingProperty}"`, null, tagPlacement);
         });
       }
 

diff --git a/test/rules/assertions/checkParamNames.js b/test/rules/assertions/checkParamNames.js
@@ -935,6 +935,7 @@ export default {
       `,
       errors: [
         {
+          line: 5,
           message: 'Missing @param "options.foo.bar"',
         },
       ],
@@ -951,6 +952,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'Missing @param "options.foo.bar.baz"',
         },
       ],