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