Skip to content

index.md

Latest commit

 

History

History
49 lines (35 loc) · 3.88 KB

index.md

File metadata and controls

49 lines (35 loc) · 3.88 KB
title eslint-plugin-react-hooks
version rc

eslint-plugin-react-hooks provides ESLint rules to enforce the Rules of React.

This plugin helps you catch violations of React's rules at build time, ensuring your components and hooks follow React's rules for correctness and performance. The lints cover both fundamental React patterns (exhaustive-deps and rules-of-hooks) and issues flagged by React Compiler. React Compiler diagnostics are automatically surfaced by this ESLint plugin, and can be used even if your app hasn't adopted the compiler yet.

**Clarification (updated):** Compiler-powered rules are available starting in `eslint-plugin-react-hooks@6.1.1` — but they are **not** included in the default `recommended` preset. If you want the compiler-powered rules, enable the `recommended-latest` preset or install `eslint-plugin-react-compiler` separately depending on your setup.

Example: to opt into compiler-powered rules, add the recommended-latest preset to your ESLint config, or include the eslint-plugin-react-compiler plugin directly if you prefer explicit control.

Refer to the plugin changelog and the recommended presets for the most up-to-date instructions.

Recommended Rules {/recommended/}

These rules are included in the recommended preset eslint-plugin-react-hooks:

  • exhaustive-deps - Validates that dependency arrays for React hooks contain all necessary dependencies
  • rules-of-hooks - Validates that components and hooks follow the Rules of Hooks

Additional Rules {/additional-rules/}

Starting in version 6.0, these rules are available to opt-in:

  • component-hook-factories - Validates higher order functions defining nested components or hooks
  • config - Validates the compiler configuration options
  • error-boundaries - Validates usage of Error Boundaries instead of try/catch for child errors
  • gating - Validates configuration of gating mode
  • globals - Validates against assignment/mutation of globals during render
  • immutability - Validates against mutating props, state, and other immutable values
  • incompatible-library - Validates against usage of libraries which are incompatible with memoization
  • preserve-manual-memoization - Validates that existing manual memoization is preserved by the compiler
  • purity - Validates that components/hooks are pure by checking known-impure functions
  • refs - Validates correct usage of refs, not reading/writing during render
  • set-state-in-effect - Validates against calling setState synchronously in an effect
  • set-state-in-render - Validates against setting state during render
  • static-components - Validates that components are static, not recreated every render
  • unsupported-syntax - Validates against syntax that React Compiler does not support
  • use-memo - Validates usage of the useMemo hook without a return value