mirror of
https://github.com/facebook/react.git
synced 2025-11-01 09:12:30 +00:00
Dan Abramov
ce6ecd3fbf
* Add 16.8.0 changelog * Mention ESLint plugin * Remove experimental notices from the ESLint plugin README * Update CHANGELOG.md * Add more details for Hooks * fix * Set a date * Update CHANGELOG.md Co-Authored-By: gaearon <dan.abramov@gmail.com> * Update CHANGELOG.md * useReducer in changelog * Add to changelog * Update date * Add #14119 to changelog * Add #14744 to changelog * Fix PR links * act() method was added to test utils, too * Updated release date to February 6th
43 lines
1003 B
Markdown
43 lines
1003 B
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"
|
|
}
|
|
}
|
|
```
|
|
|
|
## 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.
|
|
|
|
## License
|
|
|
|
MIT
|