react/packages/eslint-plugin-react-hooks
2019-03-05 14:35:53 -08:00
..
__tests__ Fix issue with multiple code branches in hooks linter (#14661) 2019-01-25 17:06:33 +00:00
npm Add ESLint rule for React Hooks 2018-10-29 11:26:54 -07:00
src fix spelling mistakes (#14805) 2019-02-09 16:43:49 -08:00
index.js Add ESLint rule for React Hooks 2018-10-29 11:26:54 -07:00
package.json Turning off eslint-plugin-react-hooks for the upcoming patch release 2019-03-05 14:35:53 -08:00
README.md Add 16.8.0 changelog and update some READMEs (#14692) 2019-02-06 08:05:18 +00:00

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"
  }
}

Valid and Invalid Examples

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

License

MIT