eslint-plugin-promise
Enforce best practices for JavaScript promises
Last updated 5 months ago by xjamundx .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install eslint-plugin-promise 
SYNC missed versions from official npm registry.

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() 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

Current Tags

  • 4.2.1                                ...           latest (5 months ago)

29 Versions

  • 4.2.1                                ...           5 months ago
  • 4.1.1                                ...           7 months ago
  • 4.1.0                                ...           7 months ago
  • 4.0.1                                ...           a year ago
  • 4.0.0                                ...           a year ago
  • 3.8.0                                ...           a year ago
  • 3.7.0                                ...           2 years ago
  • 3.6.0                                ...           2 years ago
  • 3.5.0                                ...           3 years ago
  • 3.4.2                                ...           3 years ago
  • 3.4.1                                ...           3 years ago
  • 3.4.0                                ...           3 years ago
  • 3.4.0-0                                ...           3 years ago
  • 3.3.2                                ...           3 years ago
  • 3.3.1                                ...           3 years ago
  • 3.3.0                                ...           3 years ago
  • 3.2.1                                ...           3 years ago
  • 3.2.0                                ...           3 years ago
  • 3.1.0                                ...           3 years ago
  • 3.0.0                                ...           3 years ago
  • 2.0.1                                ...           3 years ago
  • 2.0.0                                ...           3 years ago
  • 1.3.2                                ...           3 years ago
  • 1.3.1                                ...           3 years ago
  • 1.3.0                                ...           3 years ago
  • 1.2.0                                ...           3 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.8                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (2)
Downloads
Today 7,739
This Week 43,938
This Month 108,942
Last Day 9,655
Last Week 50,628
Last Month 192,333
Dependencies (0)
None
Dev Dependencies (12)
Dependents (1788)

Copyright 2014 - 2016 © taobao.org |