param-names: Update docs

Author: homersimpsons

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.2.0
+
+- Updated `param-names` rule to allow for unused params
+
 ## 5.1.1
 
 - Updated docs to include `no-callback-in-promise` reasons #215
@@ -6,7 +10,8 @@
 
 - Included `catch()` and `finally()` in `prefer-await-to-then` #196
 - Added some additional tests and upgraded some dev deps #196
-- Exempted array methods in prefer-await-to-callbacks ([#212](https://github.com/xjamundx/eslint-plugin-promise/issues/212))
+- Exempted array methods in prefer-await-to-callbacks
+  ([#212](https://github.com/xjamundx/eslint-plugin-promise/issues/212))
 
 ## 5.0.0
 

docs/rules/param-names.md

@@ -7,13 +7,15 @@ Enforce standard parameter names for Promise constructors
 ```js
 new Promise(function (resolve) { ... })
 new Promise(function (resolve, reject) { ... })
+new Promise(function (_resolve, _reject) { ... }) // Unused marker for parameters are allowed
 ```
 
 #### Invalid
 
 ```js
 new Promise(function (reject, resolve) { ... }) // incorrect order
 new Promise(function (ok, fail) { ... }) // non-standard parameter names
+new Promise(function (_, reject) { ... }) // a simple underscore is not allowed
 ```
 
 Ensures that `new Promise()` is instantiated with the parameter names

rules/param-names.js

@@ -21,7 +21,9 @@ module.exports = {
 
           if (
             (params[0].name !== 'resolve' && params[0].name !== '_resolve') ||
-            (params[1] && params[1].name !== 'reject' && params[1].name !== '_reject')
+            (params[1] &&
+              params[1].name !== 'reject' &&
+              params[1].name !== '_reject')
           ) {
             context.report({
               node,