eslint-plugin-promise
Advanced tools
Package description
The eslint-plugin-promise package is an ESLint plugin that enforces best practices and common idioms for dealing with promises in JavaScript. It provides a set of rules that catch common mistakes and enforce conventions when working with promises.
Avoiding creation of new promises outside of utility libraries
This rule ensures that the executor function of a new Promise has the parameters named 'resolve' and 'reject'.
/* eslint promise/param-names: 'error' */
new Promise((resolve, reject) => { /* executor function */ });Ensuring that each time a then() is applied to a promise, a catch() is applied as well
This rule enforces the use of catch() on unhandled promises.
/* eslint promise/catch-or-return: 'error' */
promise.then(function(data) {
// handle data
}).catch(function(error) {
// handle error
});Enforcing the return of a promise in certain contexts
This rule ensures that promise chains always return a value, preventing silent failures and unhandled rejections.
/* eslint promise/always-return: 'error' */
function foo() {
return doSomething().then(function() {
// do something else
return 'result';
});
}This plugin provides ESLint rules for async/await syntax, which is related to promises. It helps to enforce best practices and catch common mistakes when using async/await, but it does not focus on promises directly.
Part of the 'eslint-plugin-standard' plugin includes rules that are applicable to promises, as it adheres to the JavaScript Standard Style. However, it covers a broader range of JavaScript features and is not solely focused on promises.
Changelog
1.0.0 - 1.0.7
Readme
Enforce best practices for JavaScript promises.
always-catchEnsure that each time a then() is applied to a promise, a
catch() is applied as well.
myPromise.then(doSomething).catch(errors);
myPromise.then(doSomething).then(doSomethingElse).catch(errors);
myPromise.then(doSomething);
myPromise.then(doSomething, catchErrors); // catch() may be a little better
always-returnEnsure that inside a then() you make sure to return a new promise or value.
See http://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html (rule #5)
for more info on why that's a good idea.
myPromise.then((val) => val * 2));
myPromise.then(function(val) { return val * 2; });
myPromise.then(doSomething); // not sure
myPromise.then(function(val) {});
myPromise.then(() => { doSomething(); });
param-namesEnforce standard parameter names for Promise constructors
new Promise(function (resolve) { ... })
new Promise(function (resolve, reject) { ... })
// incorrect order:
new Promise(function (reject, resolve) { ... })
// non-standard parameter names:
new Promise(function (ok, fail) { ... })
Ensures that new Promise() is instantiated with the parameter names resolve, reject to avoid confusion with order such as reject, resolve. The Promise constructor uses the RevealingConstructor pattern. Using the same parameter names as the language specification makes code more uniform and easier to understand.
You'll first need to install ESLint:
$ npm i 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.
Add promise to the plugins section of your .eslintrc 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/param-names": 2,
"promise/always-return": 2,
"promise/always-catch": 2
}
}
FAQs
Enforce best practices for JavaScript promises
The npm package eslint-plugin-promise receives a total of 3,555,185 weekly downloads. As such, eslint-plugin-promise popularity was classified as popular.
We found that eslint-plugin-promise demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.