refactor: hide 'avoid-*' rules from presets and docs (#876)

Rel1cx · web-flow · commit 0478213381ed · 2024-12-10T05:50:59.000+08:00
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.19.0
+1.19.0-next.4
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/monorepo",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "private": true,
   "description": "Monorepo for eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention].",
   "keywords": [
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/core",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-debug/package.json b/packages/plugins/eslint-plugin-react-debug/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-debug",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's ESLint plugin for debugging related rules.",
   "keywords": [
     "eslint",
diff --git a/packages/plugins/eslint-plugin-react-dom/package.json b/packages/plugins/eslint-plugin-react-dom/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-dom",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's ESLint plugin for React DOM related rules.",
   "keywords": [
     "eslint",
diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/package.json b/packages/plugins/eslint-plugin-react-hooks-extra/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-hooks-extra",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's ESLint plugin for React Hooks related rules.",
   "keywords": [
     "eslint",
diff --git a/packages/plugins/eslint-plugin-react-naming-convention/package.json b/packages/plugins/eslint-plugin-react-naming-convention/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-naming-convention",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's ESLint plugin for naming convention related rules.",
   "keywords": [
     "eslint",
diff --git a/packages/plugins/eslint-plugin-react-web-api/package.json b/packages/plugins/eslint-plugin-react-web-api/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-web-api",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's ESLint plugin for interacting with Web APIs",
   "keywords": [
     "eslint",
diff --git a/packages/plugins/eslint-plugin-react-x/README.md b/packages/plugins/eslint-plugin-react-x/README.md
@@ -75,8 +75,6 @@ export default [
 
 | Rule                                     | Description                                                                                          | 💼  | 💭  |     |
 | :--------------------------------------- | :--------------------------------------------------------------------------------------------------- | :-: | :-: | :-: |
-| `avoid-shorthand-boolean`                | Prevents using shorthand syntax for boolean attributes.                                              | 🎨  |     | 🔧  |
-| `avoid-shorthand-fragment`               | Prevents using shorthand syntax for fragments.                                                       | 🎨  |     |     |
 | `ensure-forward-ref-using-ref`           | Requires that components wrapped with `forwardRef` must have a `ref` parameter.                      |  ✔️  |     |     |
 | `jsx-no-duplicate-props`                 | Prevents duplicate props in JSX.                                                                     |  ✔️  |     |     |
 | `jsx-uses-vars`                          | Prevents variables used in JSX to be marked as unused.                                               |  ✔️  |     |     |
diff --git a/packages/plugins/eslint-plugin-react-x/package.json b/packages/plugins/eslint-plugin-react-x/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-x",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "A set of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",
   "keywords": [
     "eslint",
diff --git a/packages/plugins/eslint-plugin/package.json b/packages/plugins/eslint-plugin/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.",
   "keywords": [
     "eslint",
diff --git a/packages/plugins/eslint-plugin/src/configs/all.ts b/packages/plugins/eslint-plugin/src/configs/all.ts
@@ -10,8 +10,6 @@ import * as dom from "./dom";
 export const name = "@eslint-react/all";
 
 export const rules = {
-  "@eslint-react/avoid-shorthand-boolean": "warn",
-  "@eslint-react/avoid-shorthand-fragment": "warn",
   "@eslint-react/ensure-forward-ref-using-ref": "warn",
   "@eslint-react/jsx-no-duplicate-props": "warn",
   "@eslint-react/jsx-uses-vars": "warn",
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's Shared constants and functions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/tools/package.json b/packages/tools/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/tools",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's std library and primitives.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/types",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's type definitions.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/ast/package.json b/packages/utilities/ast/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/ast",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's TSESTree AST utility module.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/jsx/package.json b/packages/utilities/jsx/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/jsx",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "ESLint React's TSESTree AST utility module for static analysis of JSX.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/var/package.json b/packages/utilities/var/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/var",
-  "version": "1.19.0",
+  "version": "1.19.0-next.4",
   "description": "TSESTree AST utility module for static analysis of variables",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/website/pages/docs/rules/_meta.ts b/website/pages/docs/rules/_meta.ts
@@ -56,8 +56,14 @@ export default {
   "prefer-read-only-props": "prefer-read-only-props",
   "prefer-shorthand-boolean": "prefer-shorthand-boolean",
   "prefer-shorthand-fragment": "prefer-shorthand-fragment",
-  "avoid-shorthand-boolean": "avoid-shorthand-boolean",
-  "avoid-shorthand-fragment": "avoid-shorthand-fragment",
+  "avoid-shorthand-boolean": {
+    title: "avoid-shorthand-boolean",
+    display: "hidden",
+  },
+  "avoid-shorthand-fragment": {
+    title: "avoid-shorthand-fragment",
+    display: "hidden",
+  },
   "dom-no-children-in-void-dom-elements": "dom/no-children-in-void-dom-elements",
   "dom-no-dangerously-set-innerhtml": "dom/no-dangerously-set-innerhtml",
   "dom-no-dangerously-set-innerhtml-with-children": "dom/no-dangerously-set-innerhtml-with-children",
diff --git a/website/pages/docs/rules/overview.md b/website/pages/docs/rules/overview.md
@@ -22,8 +22,6 @@
 
 | Rule                                                                               | Description                                                                                          | 💼  | 💭  |     |
 | :--------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------- | :-: | :-: | :-: |
-| [`avoid-shorthand-boolean`](avoid-shorthand-boolean)                               | Prevents using shorthand syntax for boolean attributes.                                              | 🎨  |     | 🔧  |
-| [`avoid-shorthand-fragment`](avoid-shorthand-fragment)                             | Prevents using shorthand syntax for fragments.                                                       | 🎨  |     |     |
 | [`ensure-forward-ref-using-ref`](ensure-forward-ref-using-ref)                     | Requires that components wrapped with `forwardRef` must have a `ref` parameter.                      |  ✔️  |     |     |
 | [`jsx-no-duplicate-props`](jsx-no-duplicate-props)                                 | Prevents duplicate props in JSX.                                                                     |  ✔️  |     |     |
 | [`jsx-uses-vars`](jsx-uses-vars)                                                   | Prevents variables used in JSX to be marked as unused.                                               |  ✔️  |     |     |
diff --git a/website/pages/roadmap.md b/website/pages/roadmap.md
@@ -15,8 +15,6 @@
 
 | Rule                                     | Description                                                                                          |
 | :--------------------------------------- | :--------------------------------------------------------------------------------------------------- |
-| `avoid-shorthand-boolean`                | Prevents using shorthand syntax for boolean attributes.                                              |
-| `avoid-shorthand-fragment`               | Prevents using shorthand syntax for fragments.                                                       |
 | `ensure-forward-ref-using-ref`           | Requires that components wrapped with `forwardRef` must have a `ref` parameter.                      |
 | `no-access-state-in-setstate`            | Prevents accessing `this.state` inside `setState` calls.                                             |
 | `no-array-index-key`                     | Prevents using array `index` as `key`.                                                               |

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@eslint-react/monorepo",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"private": true,`
`5`	`5`	`"description": "Monorepo for eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention].",`
`6`	`6`	`"keywords": [`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@eslint-react/core",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"description": "ESLint React's ESLint utility module for static analysis of React core APIs and Patterns.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-debug",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for debugging related rules.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"eslint",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-dom",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React DOM related rules.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"eslint",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-hooks-extra",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React Hooks related rules.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"eslint",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-naming-convention",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for naming convention related rules.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"eslint",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-web-api",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for interacting with Web APIs",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"eslint",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "eslint-plugin-react-x",`
`3`		`- "version": "1.19.0",`
	`3`	`+ "version": "1.19.0-next.4",`
`4`	`4`	`"description": "A set of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"eslint",`