https://github.com/pke/eslint-plugin-redux-saga

ESLint rules for redux-saga
https://github.com/pke/eslint-plugin-redux-saga

eslint redux-saga

Last synced: 7 days ago
JSON representation

ESLint rules for redux-saga

• Host: GitHub
• URL: https://github.com/pke/eslint-plugin-redux-saga
• Owner: pke
• License: mit
• Created: 2016-04-21T01:41:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-04-22T23:08:12.000Z (over 1 year ago)
• Last Synced: 2024-10-05T02:26:00.729Z (about 1 month ago)
• Topics: eslint, redux-saga
• Language: JavaScript
• Size: 267 KB
• Stars: 135
• Watchers: 6
• Forks: 16
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-plugin-redux-saga

[![Build Status](https://img.shields.io/travis/pke/eslint-plugin-redux-saga/master.svg?style=flat-square)](https://travis-ci.org/pke/eslint-plugin-redux-saga)

[![npm version](https://img.shields.io/npm/v/eslint-plugin-redux-saga.svg?style=flat-square)](https://badge.fury.io/js/eslint-plugin-redux-saga)

[![License](https://img.shields.io/npm/l/eslint-plugin-redux-saga.svg?style=flat-square)](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 | ![recommended](https://img.shields.io/badge/-recommended-lightgrey.svg) | ![suggestion fixable](https://img.shields.io/badge/-suggestion%20fixable-green.svg) |

| [no-yield-in-race](docs/rules/no-yield-in-race.md) | Prevent usage of yield in race entries | ![recommended](https://img.shields.io/badge/-recommended-lightgrey.svg) | ![fixable](https://img.shields.io/badge/-fixable-green.svg)

| [no-unhandled-errors](docs/rules/no-unhandled-errors.md) | Ensures error handling on sagas | ![recommended](https://img.shields.io/badge/-recommended-lightgrey.svg) |

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

  ]

}

```