amirho/react
1
0
Fork 0
mirror of https://github.com/facebook/react.git synced 2026-02-27 03:07:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5ccfcd17ffa0adf9e7f5ba7fbf48e6bf6a4eb67e
react/compiler/packages/eslint-plugin-react-compiler
History
lauren f31779a112 [ez] Run Prettier on eslint-plugin-react-compiler/src/types (#32590) 
Extracting portions of #32416 for easier review.

This PR contains small formatting fixes.

Co-authored-by: michael faith <michaelfaith@users.noreply.github.com>
---
[//]: # (BEGIN SAPLING FOOTER)
Stack created with [Sapling](https://sapling-scm.com). Best reviewed
with [ReviewStack](https://reviewstack.dev/facebook/react/pull/32590).
* #32592
* #32591
* __->__ #32590
* #32589
* #32588

---------

Co-authored-by: michael faith <michaelfaith@users.noreply.github.com>
2025-03-12 19:12:22 -04:00
..
__tests__
[compiler] Surface unused opt out directives in eslint
2024-08-16 18:12:05 -04:00
src
[ez] Run Prettier on eslint-plugin-react-compiler/src/types (#32590)
2025-03-12 19:12:22 -04:00
babel.config.js
Compiler: unfork prettier config (#30205)
2024-07-18 17:00:24 -04:00
package.json
[compiler] Dedupe @babel/types (#32581)
2025-03-12 17:02:10 -04:00
README.md
docs(eslint-plugin-react-compiler): fix typo (#32149)
2025-01-22 16:59:50 +01:00
tsconfig.json
[compiler] Migrate compiler packages to tsup (#32550)
2025-03-07 16:41:55 -05:00
tsup.config.ts
[compiler] Migrate compiler packages to tsup (#32550)
2025-03-07 16:41:55 -05:00

README.md

eslint-plugin-react-compiler

ESLint plugin surfacing problematic React code found by the React compiler.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-react-compiler:

npm install eslint-plugin-react-compiler --save-dev

Usage

Flat config

Edit your eslint 8+ config (for example eslint.config.mjs) with the recommended configuration:

+ import reactCompiler from "eslint-plugin-react-compiler"
import react from "eslint-plugin-react"

export default [
    // Your existing config
    { ...pluginReact.configs.flat.recommended, settings: { react: { version: "detect" } } },
+   reactCompiler.configs.recommended    
]

Legacy config (.eslintrc)

Add react-compiler to the plugins section of your configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "react-compiler"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
        "react-compiler/react-compiler": "error"
    }
}

Rules

TODO: Run eslint-doc-generator to generate the rules list.