fix: allow for array value props to be defined (#136)

gajus · Dec 19, 2018 · 3c0e3c6 · 3c0e3c6
1 parent c12b14c
commit 3c0e3c6
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/src/rules/checkParamNames.js b/src/rules/checkParamNames.js
@@ -38,7 +38,11 @@ const validateParameterNamesDeep = (targetTagName : string, jsdocParameterNames
         return true;
       }
 
-      const pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));
+      let pathRootNodeName = jsdocParameterName.slice(0, jsdocParameterName.indexOf('.'));
+
+      if (pathRootNodeName.endsWith('[]')) {
+        pathRootNodeName = pathRootNodeName.slice(0, -2);
+      }
 
       if (pathRootNodeName !== lastRealParameter) {
         report('@' + targetTagName + ' path declaration ("' + jsdocParameterName + '") root node name ("' +

diff --git a/test/rules/assertions/checkParamNames.js b/test/rules/assertions/checkParamNames.js
@@ -211,6 +211,19 @@ export default {
 
           }
       `
+    },
+    {
+      code: `
+          /**
+           * Assign the project to a list of employees.
+           * @param {Object[]} employees - The employees who are responsible for the project.
+           * @param {string} employees[].name - The name of an employee.
+           * @param {string} employees[].department - The employee's department.
+           */
+          function assign (employees) {
+
+          };
+      `
     }
   ]
 };