eslint-plugin-react-hooks
ESLint rules for React Hooks
Last updated 6 years ago by gaearon .
MIT · Repository · Bugs · Original npm · Tarball · package.json 
$ gnpm install eslint-plugin-react-hooks
SYNC missed versions from official npm registry.

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 extend the recommended eslint config:

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

Custom Configuration

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

Advanced Configuration

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.

Valid and Invalid Examples

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

License

MIT

Current Tags

  • 4.2.1-beta-24dd07bd2-20211208                                ...           beta (3 years ago)
  • 4.6.0                                ...           latest (2 years ago)
  • 5.0.0-next-8342a0992-20230327                                ...           next (2 years ago)
  • 4.2.1-rc.3                                ...           rc (3 years ago)

1466 Versions

Maintainers (8)
acdlite
brianvaughn
gaearon
gnoff
lunaruan
react-bot
threepointone
trueadm
Downloads
Today 0
This Week 0
This Month 468
Last Day 0
Last Week 468
Last Month 0
Dependencies (0)
None
Dev Dependencies (0)
None
Dependents (2)

Copyright 2013 - present © cnpmjs.org | Home |