Merge branch 'main' into no-use-in-try-catch

Rel1cx · web-flow · commit c2dbfd106f2b · 2025-02-23T09:49:28.000+08:00
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.27.1-beta.4
+1.27.1-next.5
diff --git a/apps/website/content/docs/rules/meta.json b/apps/website/content/docs/rules/meta.json
@@ -58,6 +58,7 @@
     "dom-no-dangerously-set-innerhtml",
     "dom-no-dangerously-set-innerhtml-with-children",
     "dom-no-find-dom-node",
+    "dom-no-flush-sync",
     "dom-no-missing-button-type",
     "dom-no-missing-iframe-sandbox",
     "dom-no-namespace",
diff --git a/apps/website/content/docs/rules/overview.md b/apps/website/content/docs/rules/overview.md
@@ -79,6 +79,7 @@ full: true
 | [`no-dangerously-set-innerhtml-with-children`](./dom-no-dangerously-set-innerhtml-with-children) | 2️⃣  | `🔍`          | Prevents DOM elements using `dangerouslySetInnerHTML` and `children` at the same time. |
 | [`no-dangerously-set-innerhtml`](./dom-no-dangerously-set-innerhtml)                             | 1️⃣  | `🔍`          | Prevents DOM elements using `dangerouslySetInnerHTML`.                                 |
 | [`no-find-dom-node`](./dom-no-find-dom-node)                                                     | 2️⃣  | `🔍`          | Prevents using `findDOMNode`.                                                          |
+| [`no-flush-sync`](./dom-no-flush-sync)                                                           | 1️⃣  | `🔍`          | Prevents using `flushSync`.                                                            |
 | [`no-missing-button-type`](./dom-no-missing-button-type)                                         | 1️⃣  | `🔍`          | Enforces explicit `type` attribute for `button` elements.                              |
 | [`no-missing-iframe-sandbox`](./dom-no-missing-iframe-sandbox)                                   | 1️⃣  | `🔍`          | Enforces explicit `sandbox` attribute for `iframe` elements.                           |
 | [`no-namespace`](./dom-no-namespace)                                                             | 2️⃣  | `🔍`          | Enforces the absence of a `namespace` in React elements.                               |
@@ -131,11 +132,11 @@ full: true
 
 | Rule                                                                                                       | Replaced by                                                                            | Deprecated in |
 | :--------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :------------ |
-| [`jsx-uses-vars`](jsx-uses-vars)                                                                           | [`use-jsx-vars`](./use-jsx-vars)                                                       | v1.22.0       |
-| [`jsx-no-duplicate-props`](jsx-no-duplicate-props)                                                         | [`no-duplicate-jsx-props`](./no-duplicate-jsx-props)                                   | v1.22.0       |
-| [`no-complicated-conditional-rendering`](no-complicated-conditional-rendering)                             | [`no-complex-conditional-rendering`](./no-complex-conditional-rendering)               | v1.6.0        |
-| [`dom/no-children-in-void-dom-elements`](dom-no-children-in-void-dom-elements)                             | [`dom/no-void-elements-with-children`](./dom-no-void-elements-with-children)           | v1.22.0       |
-| [`hooks-extra/no-redundant-custom-hook`](hooks-extra-no-useless-custom-hooks)                              | [`hooks-extra/no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks)         | v1.21.0       |
-| [`hooks-extra/ensure-custom-hooks-using-other-hooks`](hooks-extra-no-useless-custom-hooks)                 | [`hooks-extra/no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks)         | v1.13.0       |
-| [`hooks-extra/ensure-use-memo-has-non-empty-deps`](hooks-extra-ensure-use-memo-has-non-empty-deps)         | [`hooks-extra/no-unnecessary-use-memo`](./hooks-extra-no-unnecessary-use-memo)         | v1.13.0       |
-| [`hooks-extra/ensure-use-callback-has-non-empty-deps`](hooks-extra-ensure-use-callback-has-non-empty-deps) | [`hooks-extra/no-unnecessary-use-callback`](./hooks-extra-no-unnecessary-use-callback) | v1.13.0       |
+| [`jsx-uses-vars`](jsx-uses-vars)                                                                           | [`use-jsx-vars`](./use-jsx-vars)                                                       | 1.22.0        |
+| [`jsx-no-duplicate-props`](jsx-no-duplicate-props)                                                         | [`no-duplicate-jsx-props`](./no-duplicate-jsx-props)                                   | 1.22.0        |
+| [`no-complicated-conditional-rendering`](no-complicated-conditional-rendering)                             | [`no-complex-conditional-rendering`](./no-complex-conditional-rendering)               | 1.6.0         |
+| [`dom/no-children-in-void-dom-elements`](dom-no-children-in-void-dom-elements)                             | [`dom/no-void-elements-with-children`](./dom-no-void-elements-with-children)           | 1.22.0        |
+| [`hooks-extra/no-redundant-custom-hook`](hooks-extra-no-useless-custom-hooks)                              | [`hooks-extra/no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks)         | 1.21.0        |
+| [`hooks-extra/ensure-custom-hooks-using-other-hooks`](hooks-extra-no-useless-custom-hooks)                 | [`hooks-extra/no-useless-custom-hooks`](./hooks-extra-no-useless-custom-hooks)         | 1.13.0        |
+| [`hooks-extra/ensure-use-memo-has-non-empty-deps`](hooks-extra-ensure-use-memo-has-non-empty-deps)         | [`hooks-extra/no-unnecessary-use-memo`](./hooks-extra-no-unnecessary-use-memo)         | 1.13.0        |
+| [`hooks-extra/ensure-use-callback-has-non-empty-deps`](hooks-extra-ensure-use-callback-has-non-empty-deps) | [`hooks-extra/no-unnecessary-use-callback`](./hooks-extra-no-unnecessary-use-callback) | 1.13.0        |
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/monorepo",
-  "version": "1.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's ESLint plugin for debugging related rules.",
   "keywords": [
     "react",
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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's ESLint plugin for React DOM related rules.",
   "keywords": [
     "react",
diff --git a/packages/plugins/eslint-plugin-react-dom/src/plugin.ts b/packages/plugins/eslint-plugin-react-dom/src/plugin.ts
@@ -2,6 +2,7 @@ import { name, version } from "../package.json";
 import noDangerouslySetInnerHTML from "./rules/no-dangerously-set-innerhtml";
 import noDangerouslySetInnerHTMLWithChildren from "./rules/no-dangerously-set-innerhtml-with-children";
 import noFindDomNode from "./rules/no-find-dom-node";
+import noFlushSync from "./rules/no-flush-sync";
 import noMissingButtonType from "./rules/no-missing-button-type";
 import noMissingIframeSandbox from "./rules/no-missing-iframe-sandbox";
 import noNamespace from "./rules/no-namespace";
@@ -21,6 +22,7 @@ export const plugin = {
     "no-dangerously-set-innerhtml": noDangerouslySetInnerHTML,
     "no-dangerously-set-innerhtml-with-children": noDangerouslySetInnerHTMLWithChildren,
     "no-find-dom-node": noFindDomNode,
+    "no-flush-sync": noFlushSync,
     "no-missing-button-type": noMissingButtonType,
     "no-missing-iframe-sandbox": noMissingIframeSandbox,
     "no-namespace": noNamespace,
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-find-dom-node.md b/packages/plugins/eslint-plugin-react-dom/src/rules/no-find-dom-node.md
@@ -80,4 +80,4 @@ class AutoSelectingInput extends Component {
 
 ## Further Reading
 
-- [React: APIs findDOMNode](https://react.dev/reference/react-dom/findDOMNode)
+- [React DOM: APIs findDOMNode](https://react.dev/reference/react-dom/findDOMNode)
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.md b/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.md
@@ -0,0 +1,48 @@
+---
+title: no-flush-sync
+---
+
+**Full Name in `eslint-plugin-react-dom`**
+
+```plain copy
+react-dom/no-flush-sync
+```
+
+**Full Name in `@eslint-react/eslint-plugin`**
+
+```plain copy
+@eslint-react/dom/no-flush-sync
+```
+
+**Features**
+
+`🔍`
+
+## What it does
+
+This rule reports usages of `flushSync`.
+
+`flushSync` can significantly hurt performance, and may unexpectedly force pending Suspense boundaries to show their fallback state.
+
+Most of the time, `flushSync` can be avoided, so use `flushSync` as a last resort.
+
+## Examples
+
+### Failing
+
+```tsx
+import { flushSync } from "react-dom";
+
+flushSync(() => {
+  setSomething(123);
+});
+```
+
+## Implementation
+
+- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.ts)
+- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.spec.ts)
+
+## Further Reading
+
+- [React DOM: APIs flushSync](https://react.dev/reference/react-dom/flushSync)
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.spec.ts b/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.spec.ts
@@ -0,0 +1,34 @@
+import { allValid, ruleTester } from "../../../../../test";
+import rule, { RULE_NAME } from "./no-flush-sync";
+
+ruleTester.run(RULE_NAME, rule, {
+  invalid: [
+    {
+      code: /* tsx */ `
+        import { flushSync } from 'react-dom';
+
+        flushSync(() => {
+          setSomething(123);
+        });
+      `,
+      errors: [
+        { messageId: "noFlushSync" },
+      ],
+    },
+    {
+      code: /* tsx */ `
+        import reactDom from 'react-dom';
+
+        reactDom.flushSync(() => {
+          setSomething(123);
+        });
+      `,
+      errors: [
+        { messageId: "noFlushSync" },
+      ],
+    },
+  ],
+  valid: [
+    ...allValid,
+  ],
+});
diff --git a/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.ts b/packages/plugins/eslint-plugin-react-dom/src/rules/no-flush-sync.ts
@@ -0,0 +1,49 @@
+import type { RuleFeature } from "@eslint-react/shared";
+import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
+import type { CamelCase } from "string-ts";
+
+import { createRule } from "../utils";
+
+export const RULE_NAME = "no-flush-sync";
+
+export const RULE_FEATURES = [
+  "CHK",
+] as const satisfies RuleFeature[];
+
+export type MessageID = CamelCase<typeof RULE_NAME>;
+
+export default createRule<[], MessageID>({
+  meta: {
+    type: "problem",
+    docs: {
+      description: "warns against using `flushSync`",
+      [Symbol.for("rule_features")]: RULE_FEATURES,
+    },
+    messages: {
+      noFlushSync: "Using 'flushSync' is uncommon and can hurt the performance of your app.",
+    },
+    schema: [],
+  },
+  name: RULE_NAME,
+  create(context) {
+    if (!context.sourceCode.text.includes("flushSync")) return {};
+    return {
+      CallExpression(node) {
+        const { callee } = node;
+        switch (callee.type) {
+          case T.Identifier:
+            if (callee.name === "flushSync") {
+              context.report({ messageId: "noFlushSync", node });
+            }
+            return;
+          case T.MemberExpression:
+            if (callee.property.type === T.Identifier && callee.property.name === "flushSync") {
+              context.report({ messageId: "noFlushSync", node });
+            }
+            return;
+        }
+      },
+    };
+  },
+  defaultOptions: [],
+});
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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's ESLint plugin for React Hooks related rules.",
   "keywords": [
     "react",
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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's ESLint plugin for naming convention related rules.",
   "keywords": [
     "react",
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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's ESLint plugin for interacting with Web APIs",
   "keywords": [
     "react",
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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "A set of composable linting rules for libraries and frameworks that use React as a UI runtime.",
   "keywords": [
     "react",
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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "More than 80 high-quality linting rules for writing better React code.",
   "keywords": [
     "react",
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "1.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's Shared constants and functions.",
   "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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's TSESTree AST utility module.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/utilities/eff/package.json b/packages/utilities/eff/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eff",
-  "version": "1.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "JavaScript and TypeScript utilities (previously some re-exports of the effect library).",
   "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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "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.27.1-beta.4",
+  "version": "1.27.1-next.5",
   "description": "ESLint React's TSESTree AST utility module for static analysis of variables.",
   "homepage": "https://github.com/Rel1cx/eslint-react",
   "bugs": {

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.27.1-beta.4",`
	`3`	`+ "version": "1.27.1-next.5",`
`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.27.1-beta.4",`
	`3`	`+ "version": "1.27.1-next.5",`
`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.27.1-beta.4",`
	`3`	`+ "version": "1.27.1-next.5",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for debugging related rules.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"react",`
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.27.1-beta.4",`
	`3`	`+ "version": "1.27.1-next.5",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React DOM related rules.",`
`5`	`5`	`"keywords": [`
`6`	`6`	`"react",`
Original file line number	Diff line number	Diff line change
`@@ -80,4 +80,4 @@ class AutoSelectingInput extends Component {`
`80`	`80`
`81`	`81`	`## Further Reading`
`82`	`82`
`83`		`-- [React: APIs findDOMNode](https://react.dev/reference/react-dom/findDOMNode)`
	`83`	`+- [React DOM: APIs findDOMNode](https://react.dev/reference/react-dom/findDOMNode)`