This ESLint plugin enforces the Rules of Hooks.
It is a part of the Hooks API for React.
Note: If you're using Create React App, please use
react-scripts >= 3 instead of adding it directly.
Assuming you already have ESLint installed, run:
# npmnpm install eslint-plugin-react-hooks --save-dev# yarnyarn add eslint-plugin-react-hooks --dev
Then extend the recommended eslint config:
If you want more fine-grained configuration, you can instead add a snippet like this to your ESLint configuration file:
"plugins":// ..."react-hooks""rules":// ..."react-hooks/rules-of-hooks": "error""react-hooks/exhaustive-deps": "warn"
exhaustive-deps can be configured to validate dependencies of custom Hooks with the
This option accepts a regex to match the names of custom Hooks that have dependencies.
"rules":// ..."react-hooks/exhaustive-deps": "warn""additionalHooks": "(useMyCustomHook|useMyOtherCustomHook)"
We suggest to use this option very sparingly, if at all. Generally saying, we recommend most custom Hooks to not use the dependencies argument, and instead provide a higher-level API that is more focused around a specific use case.
Valid and Invalid Examples