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:

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

For users of 6.0 and beyond, simply add the recommended config.

import*asreactHooksfrom'eslint-plugin-react-hooks';exportdefault[// ...reactHooks.configs.recommended,];

For users of 5.2.0 (the first version with flat config support), add the recommended-latest config.

import*asreactHooksfrom'eslint-plugin-react-hooks';exportdefault[// ...reactHooks.configs['recommended-latest'],];

If you are still using ESLint below 9.0.0, you can use recommended-legacy for accessing a legacy version of the recommended config.

{"extends": [// ..."plugin:react-hooks/recommended-legacy"]}

If you're using a version earlier than 5.2.0, the legacy config was simply recommended.

{"extends": [// ..."plugin:react-hooks/recommended"]}

If you want more fine-grained configuration, you can instead add a snippet like this to your ESLint configuration file:

import*asreactHooksfrom'eslint-plugin-react-hooks';exportdefault[{files: ['**/*.{js,jsx}'],plugins: {'react-hooks': reactHooks},// ...rules: {'react-hooks/rules-of-hooks': 'error','react-hooks/exhaustive-deps': 'warn',}},];

{"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 additionalHooks option. 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.

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

MIT