46 lines
1.1 KiB
Markdown
46 lines
1.1 KiB
Markdown
|
# `eslint-plugin-react-hooks`
|
||
|
|
|
||
|
|
This ESLint plugin enforces the [Rules of Hooks](https://reactjs.org/docs/hooks-rules.html).
|
||
|
|
|
||
|
|
It is a part of the [Hooks API](https://reactjs.org/docs/hooks-intro.html) 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:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
# npm
|
||
|
|
npm install eslint-plugin-react-hooks --save-dev
|
||
|
|
|
||
|
|
# yarn
|
||
|
|
yarn add eslint-plugin-react-hooks --dev
|
||
|
|
```
|
||
|
|
|
||
|
|
Then add it to your ESLint configuration:
|
||
|
|
|
||
|
|
```js
|
||
|
|
{
|
||
|
|
"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](https://reactjs.org/docs/hooks-rules.html) documentation and the [Hooks FAQ](https://reactjs.org/docs/hooks-faq.html#what-exactly-do-the-lint-rules-enforce) to learn more about this rule.
|
||
|
|
|
||
|
|
For feedback about the `exhaustive-deps` rule, please post in [this thread](https://github.com/facebook/react/issues/14920).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|