
ESLint React

A series of composable ESLint rules for libraries and frameworks that use React as a UI runtime.
Roadmap
Features
- Universal rules for libraries and frameworks that use React as a UI runtime.
- Well designed rule behaviors and sensible defaults.
- Maximum flexibility through minimum configuration options.
Public packages
All-in-one packages
Individual packages (will be available in 2.0)
eslint-plugin-react-x - Core rules (DOM Irrelevant, Render Target Agnostic, Formatting Independent).
eslint-plugin-react-dom - DOM specific rules for React DOM.
eslint-plugin-react-hooks-extra - Extra React Hooks rules.
eslint-plugin-react-naming-convention - Naming convention rules.
Supported ESLint versions
Supported React versions
Supported engines
Node.js
Bun
Install
npm install --save-dev @eslint-react/eslint-plugin
Setup
Add the plugin to your eslint.config.js:
import js from "@eslint/js";
import react from "@eslint-react/eslint-plugin";
export default [
js.configs.recommended,
{
files: ["**/*.{ts,tsx}"],
...react.configs.recommended,
},
];
Full Installation Guide ↗
Presets
- recommended
Enable rules that are recommended by ESLint React.
- recommended-type-checked
Enable rules that are recommended by ESLint React with additional rules that require type information.
- dom
Enable rules that are specific to React DOM.
- off-dom
Disable rules that are specific to React DOM.
- off
Disable all rules in this plugin except for debug rules.
Full Presets List↗
Rules
Rules Overview ↗
FAQ
Frequently Asked Questions ↗
Contributing
Before you start working on something, it's best to check if there is an existing issue first. It's also a good idea to reach the maintainer and confirm if it makes sense or if someone else is already working on it.
Please make sure to read the Contributing Guide before making a pull request.
Thank you to everyone contributing to ESLint React!
License
This project is licensed under the MIT License - see the LICENSE file for details.
Inspiration
Prior art