https://github.com/mangs/eslint-plugin-jest-async

ESLint plugin to detect improper Jest test assertions for asynchronous (Promise-based) actions
https://github.com/mangs/eslint-plugin-jest-async

Last synced: about 1 year ago
JSON representation

ESLint plugin to detect improper Jest test assertions for asynchronous (Promise-based) actions

• Host: GitHub
• URL: https://github.com/mangs/eslint-plugin-jest-async
• Owner: mangs
• License: gpl-3.0
• Created: 2017-02-20T21:47:51.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-21T22:06:01.000Z (over 9 years ago)
• Last Synced: 2024-10-11T11:35:49.587Z (over 1 year ago)
• Language: JavaScript
• Size: 22.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# eslint-plugin-jest-async

ESLint rules for Jest to detect improper test assertions for asynchronous (Promise-based) actions

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ npm i eslint --save-dev

```

Next, install `eslint-plugin-jest-async`:

```

$ npm install eslint-plugin-jest-async --save-dev

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-jest-async` globally.

## Usage

Add `jest-async` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:

```json

{

    "plugins": [

        "jest-async"

    ]

}

```

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

```json

{

    "rules": {

        "jest-async/expect-return": "error"

    }

}

```

## Supported Rules

* [jest-async/expect-return](docs/rules/expect-return.md)