mirror of https://github.com/zebrajr/react.git synced 2025-12-07 00:20:28 +01:00

History

michael faith a657bc5dee build(eslint-plugin-react-hooks): add dev dependencies for typescript migration (#32279 ) <!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please provide enough information so that others can review your pull request. The three fields below are mandatory. Before submitting a pull request, please make sure the following is done: 1. Fork [the repository](https://github.com/facebook/react) and create your branch from `main`. 2. Run `yarn` in the repository root. 3. If you've fixed a bug or added code that should be tested, add tests! 4. Ensure the test suite passes (`yarn test`). Tip: `yarn test --watch TestName` is helpful in development. 5. Run `yarn test --prod` to test in the production environment. It supports the same options as `yarn test`. 6. If you need a debugger, run `yarn test --debug --watch TestName`, open `chrome://inspect`, and press "Inspect". 7. Format your code with [prettier](https://github.com/prettier/prettier) (`yarn prettier`). 8. Make sure your code lints (`yarn lint`). Tip: `yarn linc` to only check changed files. 9. Run the [Flow](https://flowtype.org/) type checks (`yarn flow`). 10. If you haven't already, complete the CLA. Learn more about contributing: https://reactjs.org/docs/how-to-contribute.html --> ## Summary Contributing to https://github.com/facebook/react/pull/32240, this change adds the dev dependencies needed to support the migration of the plugin to typescript.		2025-01-31 14:32:23 -05:00
..
__tests__	[compiler] Surface unused opt out directives in eslint	2024-08-16 18:12:05 -04:00
scripts	[compiler] Switch to esbuild (#31963 )	2025-01-02 16:59:56 -05:00
src	Support eslint 8+ flat plugin syntax out of the box for eslint-plugin-react-compiler (#32120 )	2025-01-18 17:41:34 -05:00
babel.config.js	Compiler: unfork prettier config (#30205 )	2024-07-18 17:00:24 -04:00
package.json	build(eslint-plugin-react-hooks): add dev dependencies for typescript migration (#32279 )	2025-01-31 14:32:23 -05:00
README.md	docs(eslint-plugin-react-compiler): fix typo (#32149 )	2025-01-22 16:59:50 +01:00
tsconfig.json	Remove comments in builds	2024-04-02 10:32:24 -04: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.