@fintechstudios/eslint-plugin-chai-as-promised

@fintechstudios/eslint-plugin-chai-as-promised

Prevent common problems when using chai-as-promised

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @fintechstudios/eslint-plugin-chai-as-promised:

$ npm install @fintechstudios/eslint-plugin-chai-as-promised --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install @fintechstudios/eslint-plugin-chai-as-promised globally.

Usage

Add @fintechstudios/chai-as-promised to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": [
    "@fintechstudios/eslint-plugin-chai-as-promised"
  ]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "@fintechstudios/chai-as-promised/no-unhandled-promises": 2,
    "@fintechstudios/chai-as-promised/no-await-in-condition": 2
  }
}

Or, to just use the configuration above as is, you can simply add the following instead:

{
  "extends": ["plugin:@fintechstudios/chai-as-promised/recommended"]
}

Supported Rules

• no-await-in-condition: Must not use await within chai-as-promised expressions
• no-unhandled-promises: Must handle promises returned from chai-as-promised expressions

Changelog

3.0.0 (2020-03-23)

Features

• no-await-in-condition: new rule to report use of await within chai-as-promised conditions (#10)

BREAKING CHANGES

• Adds new rule to recommended