fix(require-param): Object destructuring in function parameters if …

…key is string | number (quoted or otherwise)
gajus · Jul 9, 2020 · 1842fd2 · 1842fd2
1 parent 0c1c763
commit 1842fd2
Show file tree

Hide file tree

Showing 5 changed files with 61 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -11537,6 +11537,22 @@ function quux (foo, bar, {baz}) {
 
 }
 // Options: [{"checkDestructured":false}]
+
+/**
+ * @param root
+ * @param root.foo
+ */
+function quux ({"foo": bar}) {
+
+}
+
+/**
+ * @param root
+ * @param root."foo"
+ */
+function quux ({foo: bar}) {
+
+}
 ````
 
 

diff --git a/src/iterateJsdoc.js b/src/iterateJsdoc.js
@@ -236,6 +236,10 @@ const getUtils = (
     return jsdocUtils.comparePaths(name);
   };
 
+  utils.dropPathSegmentQuotes = (name) => {
+    return jsdocUtils.dropPathSegmentQuotes(name);
+  };
+
   utils.avoidDocs = () => {
     if (
       overrideReplacesDocs !== false &&

diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -828,6 +828,7 @@ const comparePaths = (name) => {
 
 export default {
   comparePaths,
+  dropPathSegmentQuotes,
   enforcedContexts,
   exemptSpeciaMethods,
   filterTags,

diff --git a/src/rules/requireParam.js b/src/rules/requireParam.js
@@ -67,8 +67,17 @@ export default iterateJsdoc(({
   const flattenedRoots = utils.flattenRoots(functionParameterNames).names;
 
   const paramIndex = {};
+  const hasParamIndex = (cur) => {
+    return _.has(paramIndex, utils.dropPathSegmentQuotes(String(cur)));
+  };
+  const getParamIndex = (cur) => {
+    return paramIndex[utils.dropPathSegmentQuotes(String(cur))];
+  };
+  const setParamIndex = (cur, idx) => {
+    paramIndex[utils.dropPathSegmentQuotes(String(cur))] = idx;
+  };
   flattenedRoots.forEach((cur, idx) => {
-    paramIndex[cur] = idx;
+    setParamIndex(cur, idx);
   });
 
   const findExpectedIndex = (jsdocTags, indexAtFunctionParams) => {
@@ -145,9 +154,9 @@ export default iterateJsdoc(({
             });
           } else {
             missingTags.push({
-              functionParameterIdx: _.has(paramIndex, rootName) ?
-                paramIndex[rootName] :
-                paramIndex[paramName],
+              functionParameterIdx: hasParamIndex(rootName) ?
+                getParamIndex(rootName) :
+                getParamIndex(paramName),
               functionParameterName: rootName,
               inc,
             });
@@ -165,10 +174,12 @@ export default iterateJsdoc(({
         const fullParamName = `${rootName}.${paramName}`;
 
         if (jsdocParameterNames && !jsdocParameterNames.find(({name}) => {
-          return name === fullParamName;
+          return utils.comparePaths(name)(fullParamName);
         })) {
           missingTags.push({
-            functionParameterIdx: paramIndex[functionParameterName[0] ? fullParamName : paramName],
+            functionParameterIdx: getParamIndex(
+              functionParameterName[0] ? fullParamName : paramName,
+            ),
             functionParameterName: fullParamName,
             inc,
             type: hasRestElement && !hasPropertyRest ? '...any' : undefined,
@@ -194,7 +205,7 @@ export default iterateJsdoc(({
       return name === funcParamName;
     })) {
       missingTags.push({
-        functionParameterIdx: paramIndex[funcParamName],
+        functionParameterIdx: getParamIndex(funcParamName),
         functionParameterName: funcParamName,
         inc,
         type,

diff --git a/test/rules/assertions/requireParam.js b/test/rules/assertions/requireParam.js
@@ -2746,5 +2746,27 @@ export default {
         },
       ],
     },
+    {
+      code: `
+          /**
+           * @param root
+           * @param root.foo
+           */
+          function quux ({"foo": bar}) {
+
+          }
+      `,
+    },
+    {
+      code: `
+          /**
+           * @param root
+           * @param root."foo"
+           */
+          function quux ({foo: bar}) {
+
+          }
+      `,
+    },
   ],
 };