docs: improve setup guide in README.md

Rel1cx · Sep 12, 2024 · ba92e76 · ba92e76
1 parent 7d0b5e2
commit ba92e76
Show file tree

Hide file tree

Showing 8 changed files with 0 additions and 102 deletions.
diff --git a/README.md b/README.md
@@ -76,8 +76,6 @@ pnpm add --save-dev @eslint-react/eslint-plugin
 
 ### Flat Config
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 
@@ -97,29 +95,6 @@ export default [
 ];
 ```
 
-### Legacy Config
-
-<details>
-<summary>Click to toggle contents</summary>
-
-Add the plugin to your `.eslintrc.json`:
-
-```json
-{
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@eslint-react/eslint-plugin"],
-  "extends": ["eslint:recommended"],
-  "overrides": [
-    {
-      "files": ["**/*.{ts,tsx}"],
-      "extends": [
-        "plugin:@eslint-react/recommended-legacy"
-      ]
-    }
-  ]
-}
-```
-
 [Full Installation Guide ↗](https://eslint-react.xyz/docs/installation)
 
 </details>
@@ -141,26 +116,6 @@ Add the plugin to your `.eslintrc.json`:
   Enable rules that are recommended by ESLint React with additional rules that require type information.\
   _This preset includes the `recommended` preset._
 
-### Legacy Config
-
-<details>
-<summary>Click to toggle contents</summary>
-
-- **core-legacy**\
-  Enable rules that are renderer-agnostic.
-- **dom-legacy**\
-  Enable rules that are specific to React DOM.
-- **web-api-legacy**\
-  Enable rules for interacting with Web APIs.
-- **recommended-legacy**\
-  Enable rules that are recommended by ESLint React.\
-  _This preset includes the `core-legacy`, `dom-legacy`, and `web-api-legacy` presets._
-- **recommended-type-checked-legacy**\
-  Enable rules that are recommended by ESLint React with additional rules that require type information.\
-  _This preset includes the `recommended-legacy` preset._
-
-</details>
-
 [Full Presets List↗](https://eslint-react.xyz/docs/presets)
 
 ## Rules

diff --git a/packages/plugins/eslint-plugin-react-debug/README.md b/packages/plugins/eslint-plugin-react-debug/README.md
@@ -14,8 +14,6 @@ npm install --save-dev eslint-plugin-react-dom
 
 ## Setup
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 

diff --git a/packages/plugins/eslint-plugin-react-dom/README.md b/packages/plugins/eslint-plugin-react-dom/README.md
@@ -14,8 +14,6 @@ npm install --save-dev eslint-plugin-react-dom
 
 ## Setup
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 

diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/README.md b/packages/plugins/eslint-plugin-react-hooks-extra/README.md
@@ -14,8 +14,6 @@ npm install --save-dev eslint-plugin-react-hooks-extra
 
 ## Setup
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 

diff --git a/packages/plugins/eslint-plugin-react-naming-convention/README.md b/packages/plugins/eslint-plugin-react-naming-convention/README.md
@@ -14,8 +14,6 @@ npm install --save-dev eslint-plugin-react-naming-convention
 
 ## Setup
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 

diff --git a/packages/plugins/eslint-plugin-react-web-api/README.md b/packages/plugins/eslint-plugin-react-web-api/README.md
@@ -11,8 +11,6 @@ npm install --save-dev eslint-plugin-react-web-api
 
 ## Setup
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 

diff --git a/packages/plugins/eslint-plugin-react-x/README.md b/packages/plugins/eslint-plugin-react-x/README.md
@@ -14,8 +14,6 @@ npm install --save-dev eslint-plugin-react-x
 
 ## Setup
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 

diff --git a/packages/plugins/eslint-plugin/README.md b/packages/plugins/eslint-plugin/README.md
@@ -76,8 +76,6 @@ pnpm add --save-dev @eslint-react/eslint-plugin
 
 ### Flat Config
 
-Add the plugin to your `eslint.config.js`:
-
 ```js
 // @ts-check
 
@@ -97,29 +95,6 @@ export default [
 ];
 ```
 
-### Legacy Config
-
-<details>
-<summary>Click to toggle contents</summary>
-
-Add the plugin to your `.eslintrc.json`:
-
-```json
-{
-  "parser": "@typescript-eslint/parser",
-  "plugins": ["@eslint-react/eslint-plugin"],
-  "extends": ["eslint:recommended"],
-  "overrides": [
-    {
-      "files": ["**/*.{ts,tsx}"],
-      "extends": [
-        "plugin:@eslint-react/recommended-legacy"
-      ]
-    }
-  ]
-}
-```
-
 [Full Installation Guide ↗](https://eslint-react.xyz/docs/installation)
 
 </details>
@@ -141,26 +116,6 @@ Add the plugin to your `.eslintrc.json`:
   Enable rules that are recommended by ESLint React with additional rules that require type information.\
   _This preset includes the `recommended` preset._
 
-### Legacy Config
-
-<details>
-<summary>Click to toggle contents</summary>
-
-- **core-legacy**\
-  Enable rules that are renderer-agnostic.
-- **dom-legacy**\
-  Enable rules that are specific to React DOM.
-- **web-api-legacy**\
-  Enable rules for interacting with Web APIs.
-- **recommended-legacy**\
-  Enable rules that are recommended by ESLint React.\
-  _This preset includes the `core-legacy`, `dom-legacy`, and `web-api-legacy` presets._
-- **recommended-type-checked-legacy**\
-  Enable rules that are recommended by ESLint React with additional rules that require type information.\
-  _This preset includes the `recommended-legacy` preset._
-
-</details>
-
 [Full Presets List↗](https://eslint-react.xyz/docs/presets)
 
 ## Rules
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,8 +14,6 @@ npm install --save-dev eslint-plugin-react-dom @@
     ## Setup
-    Add the plugin to your `eslint.config.js`:
     ```js
     // @ts-check
@@ Expand Down @@