A series of composable ESLint plugins 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 (renderer-agnostic, compatible with x-platform). -
eslint-plugin-react-dom- DOM specific rules for React DOM. -
eslint-plugin-react-web-api- Rules for interacting with Web APIs. -
eslint-plugin-react-hooks-extra- Extra React Hooks rules. -
eslint-plugin-react-naming-convention- Naming convention rules.
# npm
npm install --save-dev @eslint-react/eslint-plugin
# yarn
yarn add --dev @eslint-react/eslint-plugin
# pnpm
pnpm add --save-dev @eslint-react/eslint-plugin// 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,
},
},
];-
recommended
Enable rules that are recommended by ESLint React. -
recommended-typescript
Enable rules that are recommended by ESLint React and disable rules that can be covered by TypeScript.
This preset includes therecommendedpreset. -
recommended-type-checked
Enable rules that are recommended by ESLint React with additional rules that require type information.
This preset includes therecommended-typescriptpreset.
Data collected from GitHub dependents network, if there are any mismatch or outdated information, feel free to open issue or pull request.
Find more on GitHub Dependents.
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.