judicial-hy / 0.200103

Name Last Update
..
rules Loading commit data...
.prettierignore Loading commit data...
CHANGELOG.md Loading commit data...
README.md Loading commit data...
index.js Loading commit data...
package.json Loading commit data...

README.md

eslint-plugin-promise

Enforce best practices for JavaScript promises.

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