You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

eslint-plugin-promise

Package Overview
Dependencies
1
Maintainers
2
Versions
44
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

eslint-plugin-promise

Enforce best practices for JavaScript promises


Version published
Weekly downloads
4.7M
increased by2.33%
Maintainers
2
Created
Weekly downloads
 

Package description

What is eslint-plugin-promise?

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.

What are eslint-plugin-promise's main functionalities?

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';
  });
}

Other packages similar to eslint-plugin-promise

Readme

Source

eslint-plugin-promise

Enforce best practices for JavaScript promises.

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",
    "promise/no-multiple-resolved": "error"
  }
}

or start with the recommended rule set:

  • eslint.config.js:

    import pluginPromise from 'eslint-plugin-promise'
    export default [
      // ...
      pluginPromise.configs['flat/recommended'],
    ]
    
  • .eslintrc.*:

    {
      "extends": ["plugin:promise/recommended"]
    }
    

Rules

💼 Configurations enabled in.
⚠️ Configurations set to warn in.
🚫 Configurations disabled in.
✅ Set in the flat/recommended configuration.
✅ Set in the recommended configuration.
🔧 Automatically fixable by the --fix CLI option.

Name                     Description💼⚠️🚫🔧
always-returnRequire returning inside each then() to create readable and reusable Promise chains.
avoid-newDisallow creating new promises outside of utility libs (use pify instead).
catch-or-returnEnforce the use of catch() on un-returned promises.
no-callback-in-promiseDisallow calling cb() inside of a then() (use nodeify instead).
no-multiple-resolvedDisallow creating new promises with paths that resolve multiple times.
no-nativeRequire creating a Promise constructor before using it in an ES5 environment.
no-nestingDisallow nested then() or catch() statements.
no-new-staticsDisallow calling new on a Promise static method.🔧
no-promise-in-callbackDisallow using promises inside of callbacks.
no-return-in-finallyDisallow return statements in finally().
no-return-wrapDisallow wrapping values in Promise.resolve or Promise.reject when not needed.
param-namesEnforce consistent param names and ordering when creating new promises.
prefer-await-to-callbacksPrefer async/await to the callback pattern.
prefer-await-to-thenPrefer await to then()/catch()/finally() for reading Promise values.
valid-paramsEnforces the proper number of arguments are passed to Promise functions.

Maintainers

License

Keywords

FAQs

Package last updated on 20 Jul 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc