eslint-plugin-promise
Enforce best practices for JavaScript promises.
Installation
You'll first need to install ESLint:
npm install eslint --save-dev
Next, install eslint-plugin-promise
:
npm install eslint-plugin-promise --save-dev
Note: If you installed ESLint globally (using the -g
flag) then you must
also install eslint-plugin-promise
globally.
Usage
Add promise
to the plugins section of your .eslintrc.json
configuration
file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["promise"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"promise/always-return": "error",
"promise/no-return-wrap": "error",
"promise/param-names": "error",
"promise/catch-or-return": "error",
"promise/no-native": "off",
"promise/no-nesting": "warn",
"promise/no-promise-in-callback": "warn",
"promise/no-callback-in-promise": "warn",
"promise/avoid-new": "warn",
"promise/no-new-statics": "error",
"promise/no-return-in-finally": "warn",
"promise/valid-params": "warn"
}
}
or start with the recommended rule set:
{
"extends": ["plugin:promise/recommended"]
}
Rules
πΌ Configurations enabled in.
π« Configurations disabled in.
β
Set in the recommended
configuration.
π§ Automatically fixable by the
--fix
CLI option.
Name | Description | πΌ | π« | π§ | |
---|---|---|---|---|---|
always-return | Require returning inside each then() to create readable and reusable Promise chains. |
β | |||
avoid-new | Disallow creating new promises outside of utility libs (use pify instead). |
β | |||
catch-or-return | Enforce the use of catch() on un-returned promises. |
β | |||
no-callback-in-promise | Disallow calling cb() inside of a then() (use nodeify instead). |
β | |||
no-multiple-resolved | Disallow creating new promises with paths that resolve multiple times. | ||||
no-native | Require creating a Promise constructor before using it in an ES5 environment. |
β | |||
no-nesting | Disallow nested then() or catch() statements. |
β | |||
no-new-statics | Disallow calling new on a Promise static method. |
β | π§ | ||
no-promise-in-callback | Disallow using promises inside of callbacks. | β | |||
no-return-in-finally | Disallow return statements in finally() . |
β | |||
no-return-wrap | Disallow wrapping values in Promise.resolve or Promise.reject when not needed. |
β | |||
param-names | Enforce consistent param names and ordering when creating new promises. | β | |||
prefer-await-to-callbacks | Prefer async/await to the callback pattern. | ||||
prefer-await-to-then | Prefer await to then() /catch() /finally() for reading Promise values. |
||||
valid-params | Enforces the proper number of arguments are passed to Promise functions. | β |
Maintainers
- Jamund Ferguson - @xjamundx
- Macklin Underdown - @macklinu
- Aadit M Shah - @aaditmshah
License
- (c) MMXV jden mailto:jason@denizac.org - ISC license.
- (c) 2016 Jamund Ferguson mailto:jamund@gmail.com - ISC license.