eslint-plugin-redux-saga
Version:
redux-saga eslint rules
52 lines (34 loc) • 1.76 kB
Markdown
# eslint-plugin-redux-saga
[](https://github.com/pke/eslint-plugin-redux-saga/actions/workflows/ci.yml)
[](https://badge.fury.io/js/eslint-plugin-redux-saga)
[](LICENSE)
[ESLint](https://github.com/eslint/eslint) rules for [redux-saga](https://github.com/yelouafi/redux-saga).
## Usage
Install the plugin:
### npm
`npm i -D eslint-plugin-redux-saga`
### yarn
`yarn add -D eslint-plugin-redux-saga`
And add it to your `.eslintrc` file:
```json
{
"plugins": [
"redux-saga"
]
}
```
## Rules
| Rule | Description | Recommended | Fixable |
|-------------|------|-------------|---------|
| [yield-effects](docs/rules/yield-effects.md) | Ensure effects are yielded |  |  |
| [no-yield-in-race](docs/rules/no-yield-in-race.md) | Prevent usage of yield in race entries |  | 
| [no-unhandled-errors](docs/rules/no-unhandled-errors.md) | Ensures error handling on sagas |  |
## Recommended configuration
This plugin exports the `recommended` configuration that enforces all the rules. To use it, add following property to `.eslintrc` file:
```json
{
"extends": [
"plugin:redux-saga/recommended"
]
}
```