🌜
🌞
eslint-plugin-promise

eslint-plugin-promise

v6.0.0

Enforce best practices for JavaScript promises

npm install eslint-plugin-promise

README

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

rule description recommended fixable
catch-or-return Enforces the use of catch() on un-returned promises. :bangbang:
no-return-wrap Avoid wrapping values in Promise.resolve or Promise.reject when not needed. :bangbang:
param-names Enforce consistent param names and ordering when creating new promises. :bangbang:
always-return Return inside each then() to create readable and reusable Promise chains. :bangbang:
no-native In an ES5 environment, make sure to create a Promise constructor before using.
no-nesting Avoid nested then() or catch() statements :warning:
no-promise-in-callback Avoid using promises inside of callbacks :warning:
no-callback-in-promise Avoid calling cb() inside of a then() (use nodeify instead) :warning:
avoid-new Avoid creating new promises outside of utility libs (use pify instead)
no-new-statics Avoid calling new on a Promise static method :bangbang: :wrench:
no-return-in-finally Disallow return statements in finally() :warning:
valid-params Ensures the proper number of arguments are passed to Promise functions :warning:
prefer-await-to-then Prefer await to then()/catch()/finally() for reading Promise values :seven:
prefer-await-to-callbacks Prefer async/await to the callback pattern :seven:

Key

icon description
: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

General

License
ISC
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
753
Community Interest
795
Number of Forks
89

Maintenance

Commits
10/219/22025
Last Commit
Open Issues
40
Closed Issues
78
Open Pull Requests
11
Closed Pull Requests
112

Versions

Versions Released
10/219/2202
Latest Version Released
Dec 18, 2021
Current Tags
latest6.0.0

Contributors

xjamundx
xjamundx
Commits: 56
macklinu
macklinu
Commits: 50
brettz9
brettz9
Commits: 12
ChristianMurphy
ChristianMurphy
Commits: 4
ota-meshi
ota-meshi
Commits: 3
thisgeek
thisgeek
Commits: 3
ahuff44
ahuff44
Commits: 3
ddsol
ddsol
Commits: 3
zloirock
zloirock
Commits: 2
geoffdutton
geoffdutton
Commits: 2
mikegreiling
mikegreiling
Commits: 2
lparry
lparry
Commits: 2
cherryblossom000
cherryblossom000
Commits: 2
ForbesLindesay
ForbesLindesay
Commits: 2
feross
feross
Commits: 2