mirror of https://github.com/facebook/react.git synced 2026-02-24 20:53:03 +00:00

Files

David Garner a807c307c4 [eslint] Check forwardRef callbacks (#17255 )

* [eslint] Check forwardRef callbacks (#17220)

* [eslint] Make tests more realistic (#17220)

* [eslint] Check anonymous callback of React.memo for rules-of-hooks (#17220)

* [eslint] Add tests for callbacks not known to be components (#17220)

* [eslint] Correct comments and add another test (#17220)

2019-11-17 13:39:08 +00:00

__tests__

[eslint] Check forwardRef callbacks (#17255 )

2019-11-17 13:39:08 +00:00

npm

Add ESLint rule for React Hooks

2018-10-29 11:26:54 -07:00

src

[eslint] Check forwardRef callbacks (#17255 )

2019-11-17 13:39:08 +00:00

index.js

Add ESLint rule for React Hooks

2018-10-29 11:26:54 -07:00

package.json

update version numbers for 16.12

2019-11-14 16:02:18 -08:00

README.md

Fix sample ESLint configuration (#14926 )

2019-02-22 12:22:07 +00:00

README.md

`eslint-plugin-react-hooks`

This ESLint plugin enforces the Rules of Hooks.

It is a part of the Hooks API for React.

Installation

Note: If you're using Create React App, please wait for a corresponding release of react-scripts that includes this rule instead of adding it directly.

Assuming you already have ESLint installed, run:

# npm
npm install eslint-plugin-react-hooks --save-dev

# yarn
yarn add eslint-plugin-react-hooks --dev

Then add it to your ESLint configuration:

{
  "plugins": [
    // ...
    "react-hooks"
  ],
  "rules": {
    // ...
    "react-hooks/rules-of-hooks": "error",
    "react-hooks/exhaustive-deps": "warn"
  }
}

Valid and Invalid Examples

Please refer to the Rules of Hooks documentation and the Hooks FAQ to learn more about this rule.

For feedback about the exhaustive-deps rule, please post in this thread.

License

MIT