0 Fork 0

mirror of https://github.com/facebook/react.git synced 2025-11-01 09:12:30 +00:00

Files

T

Gabriel McAdamsandDan Abramov 3f46844899 [eslint-plugin-react-hooks] Added meta property (including docs) (#16607 )

* [eslint-plugin-react-hooks] Added meta property (including docs)

* [eslint-plugin-react-hooks] Fixed typo (`RuleOfHooks` -> `RulesOfHooks`)

Co-authored-by: Dan Abramov <dan.abramov@gmail.com>

2020-04-01 21:13:10 +01:00

__tests__

Fix ESLint rule crash (#18455 )

2020-04-01 20:54:42 +01:00

npm

Add ESLint rule for React Hooks

2018-10-29 11:26:54 -07:00

src

[eslint-plugin-react-hooks] Added meta property (including docs) (#16607 )

2020-04-01 21:13:10 +01:00

index.js

Move remaining things to named exports (#18165 )

2020-02-27 17:18:55 -08:00

package.json

eslint-plugin-react-hooks@3.0.0

2020-03-26 17:59:25 +00:00

README.md

feat: add recommended config eslint rule (#14762 )

2020-02-28 02:01:17 +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 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

Then add it to your ESLint configuration:

{
  "plugins": [
    // ...
    "react-hooks"
  ],
  "rules": {
    // ...
    "react-hooks/rules-of-hooks": "error",
    "react-hooks/exhaustive-deps": "warn"
  }
}

Or use the recommended config:

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

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