5abf040b42 | ||
---|---|---|
.. | ||
cjs | ||
LICENSE | ||
README.md | ||
build-info.json | ||
index.js | ||
package.json |
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