OSSForks/react
1
0
Fork 0
mirror of https://github.com/zebrajr/react.git synced 2025-12-06 00:20:04 +01:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

[eprh] Update installation instructions in readme (#34331)

Browse Source 
Small PR to update our readme for eslint-plugin-react-hooks, to better
describe what a minimal but complete eslint config would look like.
This commit is contained in:
lauren 2025-08-28 18:27:49 -04:00 committed by GitHub
parent c5362a380f
commit 872b4fef6d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
packages/eslint-plugin-react-hooks/README.md
View File

@ -22,15 +22,22 @@ yarn add eslint-plugin-react-hooks --dev
#### >= 6.0.0
For users of 6.0 and beyond, simply add the `recommended` config.
For users of 6.0 and beyond, add the `recommended` config.
```js
import * as reactHooks from 'eslint-plugin-react-hooks';
// eslint.config.js
import reactHooks from 'eslint-plugin-react-hooks';
import { defineConfig } from 'eslint/config';
export default [
// ...
reactHooks.configs.recommended,
];
export default defineConfig([
{
files: ["src/**/*.{js,jsx,ts,tsx}"],
plugins: {
'react-hooks': reactHooks,
},
extends: ['react-hooks/recommended'],
},
]);
```
#### 5.2.0
@ -38,12 +45,18 @@ export default [
For users of 5.2.0 (the first version with flat config support), add the `recommended-latest` config.
```js
import * as reactHooks from 'eslint-plugin-react-hooks';
import reactHooks from 'eslint-plugin-react-hooks';
import { defineConfig } from 'eslint/config';
export default [
// ...
reactHooks.configs['recommended-latest'],
];
export default defineConfig([
{
files: ["src/**/*.{js,jsx,ts,tsx}"],
plugins: {
'react-hooks': reactHooks,
},
extends: ['react-hooks/recommended-latest'],
},
]);
```
### Legacy Config (.eslintrc)