feat: support <ArrayPattern> (Fixes #94) (#117)

- Docs (README): Update `<ObjectPattern>` link

Author: brettz9

.README/rules/check-param-names.md

@@ -25,4 +25,6 @@ function quux ({
 }
 ```
 
-`{a, b}` is an [`ObjectPattern`](https://github.com/estree/estree/blob/master/es6.md#objectpattern) AST type and does not have a name. Therefore, the associated parameter in JSDoc block can have any name.
+`{a, b}` is an [`ObjectPattern`](https://github.com/estree/estree/blob/master/es2015.md#objectpattern) AST type and does not have a name. Therefore, the associated parameter in JSDoc block can have any name.
+
+Likewise for the pattern `[a, b]` which is an [`ArrayPattern`](https://github.com/estree/estree/blob/master/es2015.md#arraypattern).

README.md

@@ -313,6 +313,13 @@ function quux ({a, b}) {
  */
 function quux ({a, b} = {}) {
 
+}
+
+/**
+ * @param foo
+ */
+function quux ([a, b] = []) {
+
 }
 ```
 
@@ -334,7 +341,9 @@ function quux ({
 }
 ```
 
-`{a, b}` is an [`ObjectPattern`](https://github.com/estree/estree/blob/master/es6.md#objectpattern) AST type and does not have a name. Therefore, the associated parameter in JSDoc block can have any name.
+`{a, b}` is an [`ObjectPattern`](https://github.com/estree/estree/blob/master/es2015.md#objectpattern) AST type and does not have a name. Therefore, the associated parameter in JSDoc block can have any name.
+
+Likewise for the pattern `[a, b]` which is an [`ArrayPattern`](https://github.com/estree/estree/blob/master/es2015.md#arraypattern).
 
 <a name="eslint-plugin-jsdoc-rules-check-tag-names"></a>
 ### <code>check-tag-names</code>

src/jsdocUtils.js

@@ -15,6 +15,10 @@ const getFunctionParameterNames = (functionNode : Object) : Array<string> => {
       return '<ObjectPattern>';
     }
 
+    if (param.type === 'ArrayPattern' || _.get(param, 'left.type') === 'ArrayPattern') {
+      return '<ArrayPattern>';
+    }
+
     if (param.type === 'RestElement') {
       return param.argument.name;
     }

src/rules/checkParamNames.js

@@ -11,7 +11,7 @@ const validateParameterNames = (targetTagName : string, functionParameterNames :
       return true;
     }
 
-    if (functionParameterName === '<ObjectPattern>') {
+    if (functionParameterName === '<ObjectPattern>' || functionParameterName === '<ArrayPattern>') {
       return false;
     }
 

test/rules/assertions/checkParamNames.js

@@ -199,6 +199,16 @@ export default {
            */
           function quux ({a, b} = {}) {
 
+          }
+      `
+    },
+    {
+      code: `
+          /**
+           * @param foo
+           */
+          function quux ([a, b] = []) {
+
           }
       `
     }