react/compiler/packages/eslint-plugin-react-compiler
Lauren Tan b57d282369
Revert "[compiler][eslint] remove compilationMode override; report bailouts on first line"
This reverts commit b34b750729.

This hack doesn't play well internally so I'm reverting this for now
(but keeping the compilationMode override). I'll audit the locations we
report later and try to make them more accurate so we won't need this
workaround.

ghstack-source-id: b6be29c11d
Pull Request resolved: https://github.com/facebook/react/pull/30792
2024-08-22 15:04:39 -04:00
..
__tests__ [compiler] Surface unused opt out directives in eslint 2024-08-16 18:12:05 -04:00
src Revert "[compiler][eslint] remove compilationMode override; report bailouts on first line" 2024-08-22 15:04:39 -04:00
babel.config.js Compiler: unfork prettier config (#30205) 2024-07-18 17:00:24 -04:00
package.json [compiler] Add git info to package.json files in compiler packages (#30475) 2024-07-26 12:56:39 -04:00
README.md [React Compiler] Fix rule name for ESLint plugin (#29096) 2024-05-16 12:36:22 -04:00
rollup.config.js Compiler: unfork prettier config (#30205) 2024-07-18 17:00:24 -04:00
tsconfig.json Remove comments in builds 2024-04-02 10:32:24 -04:00

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

Add react-compiler to the plugins section of your .eslintrc 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.