A series of composable ESLint rules rewritten from scratch for libraries and frameworks that use React as a UI runtime.
- Universal rules for libraries and frameworks that use React as a UI runtime.
- Well designed rule behaviors and sensible defaults.
- Maximum flexibility through minimum rule options.
@eslint-react/eslint-plugin- The main ESLint plugin package including all rules and config presets in this repository.
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.
- 8.57.0 or later
- 18.2.0 or later
- 18.18.0 or later
- 1.0.15 or later
# npm
npm install --save-dev @eslint-react/eslint-pluginAdd the plugin to your eslint.config.js:
// @ts-check
import js from "@eslint/js";
import react from "@eslint-react/eslint-plugin";
import * as tsParser from "@typescript-eslint/parser";
export default [
js.configs.recommended,
{
files: ["**/*.{ts,tsx}"],
...react.configs.recommended,
languageOptions: {
parser: tsParser,
},
},
];Add the plugin to your .eslintrc.json:
{
"parser": "@typescript-eslint/parser",
"plugins": ["@eslint-react/eslint-plugin"],
"extends": ["eslint:recommended"],
"overrides": [
{
"files": ["**/*.{ts,tsx}"],
"extends": [
"plugin:@eslint-react/recommended-legacy"
]
}
]
}- 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.
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!
This project is licensed under the MIT License - see the LICENSE file for details.