npm.devtool.tech
👏 You can access eslint-plugin-promise package with using eslintPluginPromise variable in browser devtools!
Enforce best practices for JavaScript promises

code/package/bundle size

0B
publish
0B
install
0B
bundle minified
0B
bundle gzipped

eslint-plugin-promise

Enforce best practices for JavaScript promises.

travis-ci npm version code style: prettier

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

ruledescriptionrecommendedfixable
catch-or-returnEnforces the use of catch() on un-returned promises.:bangbang:
no-return-wrapAvoid wrapping values in Promise.resolve or Promise.reject when not needed.:bangbang:
param-namesEnforce consistent param names and ordering when creating new promises.:bangbang:
always-returnReturn inside each then() to create readable and reusable Promise chains.:bangbang:
no-nativeIn an ES5 environment, make sure to create a Promise constructor before using.
no-nestingAvoid nested then() or catch() statements:warning:
no-promise-in-callbackAvoid using promises inside of callbacks:warning:
no-callback-in-promiseAvoid calling cb() inside of a then() (use nodeify instead):warning:
avoid-newAvoid creating new promises outside of utility libs (use pify instead)
no-new-staticsAvoid calling new on a Promise static method:bangbang::wrench:
no-return-in-finallyDisallow return statements in finally():warning:
valid-paramsEnsures the proper number of arguments are passed to Promise functions:warning:
prefer-await-to-thenPrefer await to then()/catch()/finally() for reading Promise values:seven:
prefer-await-to-callbacksPrefer async/await to the callback pattern:seven:

Key

icondescription
:bangbang:Reports as error in recommended configuration
:warning:Reports as warning in recommended configuration
:seven:ES2017 Async Await rules
:wrench:Rule is fixable with eslint --fix

Maintainers

License

🔎Explore Package🔎CDN Script

Score

Popularity57/100
Quality93/100
Maintenance67/100