fix(require-param, check-param-names): do not fail with destructured array pattern containing empty slots; fixes #716

Also ensures array indexes are quoted in output and examples as per jsdoc rules

Author: brettz9

README.md

@@ -2684,7 +2684,7 @@ function quux (error, cde = 1) {
 function quux ([a, b] = []) {
 
 }
-// Message: Missing @param "foo.0"
+// Message: Missing @param "foo."0""
 
 /**
  * @param options
@@ -3191,12 +3191,12 @@ export default function Item({
 /**
  * @param obj
  * @param obj.data
- * @param obj.data.0
- * @param obj.data.1
- * @param obj.data.2
+ * @param obj.data."0"
+ * @param obj.data."1"
+ * @param obj.data."2"
  * @param obj.defaulting
- * @param obj.defaulting.0
- * @param obj.defaulting.1
+ * @param obj.defaulting."0"
+ * @param obj.defaulting."1"
  */
 function Item({
   data: [foo, bar, ...baz],
@@ -3239,6 +3239,13 @@ class A {
     }) {
     }
 }
+
+/**
+ * @param root
+ * @param root."0" Ignored
+ * @param root."1" Our "b"
+ */
+const foo = ([, b]) => b;
 ````
 
 
@@ -13008,12 +13015,12 @@ function quux ({opts: {num, ...extra}}) {
 
 /**
  * @param {GenericArray} cfg
- * @param {number} cfg.0
+ * @param {number} cfg."0"
  */
 function baar ([a, ...extra]) {
   //
 }
-// Message: Missing JSDoc @param "cfg.1" declaration.
+// Message: Missing JSDoc @param "cfg."1"" declaration.
 
 /**
  * @param a
@@ -13613,7 +13620,7 @@ function quux ({num, ...extra}) {
 
 /**
   * @param {GenericArray} cfg
-  * @param {number} cfg.0
+  * @param {number} cfg."0"
  */
 function baar ([a, ...extra]) {
   //
@@ -13716,12 +13723,12 @@ function quux ({ foo: { bar } }) {}
 /**
  * @param obj
  * @param obj.data
- * @param obj.data.0
- * @param obj.data.1
- * @param obj.data.2
+ * @param obj.data."0"
+ * @param obj.data."1"
+ * @param obj.data."2"
  * @param obj.defaulting
- * @param obj.defaulting.0
- * @param obj.defaulting.1
+ * @param obj.defaulting."0"
+ * @param obj.defaulting."1"
  */
 function Item({
   data: [foo, bar, ...baz],

src/jsdocUtils.js

@@ -197,8 +197,8 @@ const getFunctionParameterNames = (
       const elements = param.elements || param.left?.elements;
       const roots = elements.map((prop, idx) => {
         return {
-          name: idx,
-          restElement: prop.type === 'RestElement',
+          name: `"${idx}"`,
+          restElement: prop?.type === 'RestElement',
         };
       });
 

test/rules/assertions/checkParamNames.js

@@ -682,11 +682,11 @@ export default {
       errors: [
         {
           line: 3,
-          message: 'Missing @param "foo.0"',
+          message: 'Missing @param "foo."0""',
         },
         {
           line: 3,
-          message: 'Missing @param "foo.1"',
+          message: 'Missing @param "foo."1""',
         },
       ],
     },
@@ -1571,12 +1571,12 @@ export default {
       /**
        * @param obj
        * @param obj.data
-       * @param obj.data.0
-       * @param obj.data.1
-       * @param obj.data.2
+       * @param obj.data."0"
+       * @param obj.data."1"
+       * @param obj.data."2"
        * @param obj.defaulting
-       * @param obj.defaulting.0
-       * @param obj.defaulting.1
+       * @param obj.defaulting."0"
+       * @param obj.defaulting."1"
        */
       function Item({
         data: [foo, bar, ...baz],
@@ -1640,5 +1640,15 @@ export default {
       `,
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+      /**
+       * @param root
+       * @param root."0" Ignored
+       * @param root."1" Our "b"
+       */
+      const foo = ([, b]) => b;
+      `,
+    },
   ],
 };

test/rules/assertions/requireParam.js

@@ -1006,10 +1006,10 @@ export default {
           message: 'Missing JSDoc @param "root0" declaration.',
         },
         {
-          message: 'Missing JSDoc @param "root0.0" declaration.',
+          message: 'Missing JSDoc @param "root0."0"" declaration.',
         },
         {
-          message: 'Missing JSDoc @param "root0.1" declaration.',
+          message: 'Missing JSDoc @param "root0."1"" declaration.',
         },
         {
           message: 'Missing JSDoc @param "foo" declaration.',
@@ -1018,8 +1018,8 @@ export default {
       output: `
       /**
        * @param root0
-       * @param root0.0
-       * @param root0.1
+       * @param root0."0"
+       * @param root0."1"
        * @param foo
        */
       function quux ([bar, baz], foo) {
@@ -1786,22 +1786,22 @@ export default {
       code: `
       /**
        * @param {GenericArray} cfg
-       * @param {number} cfg.0
+       * @param {number} cfg."0"
        */
       function baar ([a, ...extra]) {
         //
       }
       `,
       errors: [
         {
-          message: 'Missing JSDoc @param "cfg.1" declaration.',
+          message: 'Missing JSDoc @param "cfg."1"" declaration.',
         },
       ],
       output: `
       /**
        * @param {GenericArray} cfg
-       * @param {number} cfg.0
-       * @param {...any} cfg.1
+       * @param {number} cfg."0"
+       * @param {...any} cfg."1"
        */
       function baar ([a, ...extra]) {
         //
@@ -2898,7 +2898,7 @@ export default {
       code: `
       /**
         * @param {GenericArray} cfg
-        * @param {number} cfg.0
+        * @param {number} cfg."0"
        */
       function baar ([a, ...extra]) {
         //
@@ -3068,12 +3068,12 @@ export default {
       /**
        * @param obj
        * @param obj.data
-       * @param obj.data.0
-       * @param obj.data.1
-       * @param obj.data.2
+       * @param obj.data."0"
+       * @param obj.data."1"
+       * @param obj.data."2"
        * @param obj.defaulting
-       * @param obj.defaulting.0
-       * @param obj.defaulting.1
+       * @param obj.defaulting."0"
+       * @param obj.defaulting."1"
        */
       function Item({
         data: [foo, bar, ...baz],