fix(check-param-names): check duplicate nested names; fixes #474

gajus · Jan 7, 2020 · c51d616 · c51d616
1 parent 3e8ea59
commit c51d616
Show file tree

Hide file tree

Showing 3 changed files with 102 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1631,6 +1631,38 @@ function quux (foo, foo) {
 }
 // Message: Duplicate @param "foo"
 
+/**
+ * @param cfg
+ * @param cfg.foo
+ * @param cfg.foo
+ */
+function quux ({foo, bar}) {
+
+}
+// Message: Duplicate @param "cfg.foo"
+
+/**
+ * @param cfg
+ * @param cfg.foo
+ * @param [cfg.foo]
+ * @param baz
+ */
+function quux ({foo, bar}, baz) {
+
+}
+// Message: Duplicate @param "cfg.foo"
+
+/**
+ * @param cfg
+ * @param cfg.foo
+ * @param [cfg.foo="with a default"]
+ * @param baz
+ */
+function quux ({foo, bar}, baz) {
+
+}
+// Message: Duplicate @param "cfg.foo"
+
 export class SomeClass {
   /**
    * @param prop

diff --git a/src/rules/checkParamNames.js b/src/rules/checkParamNames.js
@@ -7,8 +7,13 @@ const validateParameterNames = (
   functionParameterNames : Array<string>, jsdoc, jsdocNode, utils, report,
 ) => {
   const paramTags = entries(jsdoc.tags).filter(([, tag]) => {
-    return tag.tag === targetTagName && !tag.name.includes('.');
+    return tag.tag === targetTagName;
   });
+  const paramTagsNonNested = paramTags.filter(([, tag]) => {
+    return !tag.name.includes('.');
+  });
+
+  let dotted = 0;
 
   return paramTags.some(([, tag], index) => {
     let tagsIndex;
@@ -24,7 +29,13 @@ const validateParameterNames = (
 
       return true;
     }
-    const functionParameterName = functionParameterNames[index];
+    if (tag.name.includes('.')) {
+      dotted++;
+
+      return false;
+    }
+
+    const functionParameterName = functionParameterNames[index - dotted];
 
     if (!functionParameterName) {
       if (allowExtraTrailingParamDocs) {
@@ -46,7 +57,7 @@ const validateParameterNames = (
 
     if (functionParameterName !== tag.name.trim()) {
       const expectedNames = functionParameterNames.join(', ');
-      const actualNames = paramTags.map(([, {name}]) => {
+      const actualNames = paramTagsNonNested.map(([, {name}]) => {
         return name.trim();
       }).join(', ');
 

diff --git a/test/rules/assertions/checkParamNames.js b/test/rules/assertions/checkParamNames.js
@@ -188,6 +188,62 @@ export default {
         },
       ],
     },
+    {
+      code: `
+          /**
+           * @param cfg
+           * @param cfg.foo
+           * @param cfg.foo
+           */
+          function quux ({foo, bar}) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'Duplicate @param "cfg.foo"',
+        },
+      ],
+    },
+    {
+      code: `
+          /**
+           * @param cfg
+           * @param cfg.foo
+           * @param [cfg.foo]
+           * @param baz
+           */
+          function quux ({foo, bar}, baz) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'Duplicate @param "cfg.foo"',
+        },
+      ],
+    },
+    {
+      code: `
+          /**
+           * @param cfg
+           * @param cfg.foo
+           * @param [cfg.foo="with a default"]
+           * @param baz
+           */
+          function quux ({foo, bar}, baz) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'Duplicate @param "cfg.foo"',
+        },
+      ],
+    },
     {
       code: `
         export class SomeClass {