Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

eslint-plugin-react-hooks

Package Overview
Dependencies
0
Maintainers
7
Versions
973
Issues
File Explorer

Advanced tools

eslint-plugin-react-hooks

ESLint rules for React Hooks

    4.6.0latest

Version published
Maintainers
7
Weekly downloads
10,337,875
decreased by-11.9%

Weekly downloads

Readme

Source

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

Keywords

FAQs

What is eslint-plugin-react-hooks?

ESLint rules for React Hooks

Is eslint-plugin-react-hooks popular?

The npm package eslint-plugin-react-hooks receives a total of 9,782,352 weekly downloads. As such, eslint-plugin-react-hooks popularity was classified as popular.

Is eslint-plugin-react-hooks well maintained?

We found that eslint-plugin-react-hooks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 7 open source maintainers collaborating on the project.

Last updated on 14 Jun 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc