mirror of https://github.com/zebrajr/react.git synced 2025-12-07 00:20:28 +01:00

History

Redmond Tran 793ef9b855 test(eslint-plugin-react-hooks): add coverage for unused custom hook (#15130 )		2019-04-25 12:15:29 +01:00
..
__tests__	test(eslint-plugin-react-hooks): add coverage for unused custom hook (#15130 )	2019-04-25 12:15:29 +01:00
npm	Add ESLint rule for React Hooks	2018-10-29 11:26:54 -07:00
src	Warn about setState directly in dep-less useEffect (#15184 )	2019-03-22 13:41:10 +00:00
index.js	Add ESLint rule for React Hooks	2018-10-29 11:26:54 -07:00
package.json	eslint-plugin-react-hooks@1.6.0	2019-03-22 13:56:07 +00:00
README.md	Fix sample ESLint configuration (#14926 )	2019-02-22 12:22:07 +00:00

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