Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DianaSuvorova/eslint-plugin-react-redux
Enforcing best practices for react-redux
https://github.com/DianaSuvorova/eslint-plugin-react-redux
Last synced: about 2 months ago
JSON representation
Enforcing best practices for react-redux
- Host: GitHub
- URL: https://github.com/DianaSuvorova/eslint-plugin-react-redux
- Owner: DianaSuvorova
- Created: 2017-12-26T22:50:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-24T15:43:54.000Z (3 months ago)
- Last Synced: 2024-07-19T08:34:27.063Z (2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-plugin-react-redux
- Size: 314 KB
- Stars: 83
- Watchers: 4
- Forks: 17
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-eslint - React-Redux - React-Redux specific linting rules. (Plugins / Frameworks)
README
# eslint-plugin-react-redux
Enforcing best practices for react-redux
## Installation
You'll first need to install [ESLint](http://eslint.org):
```
$ npm i eslint --save-dev
```
Next, install `eslint-plugin-react-redux`:
```
$ npm install eslint-plugin-react-redux --save-dev
```
**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-react-redux` globally.
## Usage
Add `react-redux` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
```json
{
"plugins": [
"react-redux"
],
"extends": [
"plugin:react-redux/recommended"
]
}
```
To configure individual rules:
```json
{
"rules": {
"react-redux/connect-prefer-named-arguments": 2
}
}
```
## Supported Rules
* [react-redux/connect-prefer-minimum-two-arguments](docs/rules/connect-prefer-minimum-two-arguments.md) Enforces that connect function has at least 2 arguments.
* [react-redux/connect-prefer-named-arguments](docs/rules/connect-prefer-named-arguments.md) Enforces that all connect arguments have recommended names.
* [react-redux/mapDispatchToProps-returns-object](docs/rules/mapDispatchToProps-returns-object.md) Enforces that mapDispatchToProps returns an object.
* [react-redux/mapDispatchToProps-prefer-shorthand](docs/rules/mapDispatchToProps-prefer-shorthand.md) Enforces that all mapDispatchToProps use a shorthand method to wrap actions in dispatch calls whenever possible.
* [react-redux/mapDispatchToProps-prefer-parameters-names](docs/rules/mapDispatchToProps-prefer-parameters-names.md) Enforces that all mapDispatchToProps parameters have specific names.
* [react-redux/mapStateToProps-no-store](docs/rules/mapStateToProps-no-store.md) Prohibits binding a whole store object to a component.
* [react-redux/mapStateToProps-prefer-hoisted](docs/rules/mapStateToProps-prefer-hoisted.md) Flags generation of copies of same-by-value but different-by-reference props.
* [react-redux/mapStateToProps-prefer-parameters-names](docs/rules/mapStateToProps-prefer-parameters-names.md) Enforces that all mapStateToProps parameters have specific names.
* [react-redux/mapStateToProps-prefer-selectors](docs/rules/mapStateToProps-prefer-selectors.md) Enforces that all mapStateToProps properties use selector functions.
* [react-redux/useSelector-prefer-selectors](docs/rules/useSelector-prefer-selectors.md) Enforces that all useSelector properties use selector functions.
* [react-redux/no-unused-prop-types](docs/rules/no-unused-prop-types.md) Extension of a react's no-unused-prop-types rule filtering out false positive used in redux context.
* [react-redux/prefer-separate-component-file](docs/rules/prefer-separate-component-file.md) Enforces that all connected components are defined in a separate file.