feat: react/no-unstable-default-props support checking for ObjectPatterns within VariableDeclarators that occur on props

Rel1cx · Rel1cx · commit 18edb240a4c4 · 2024-01-06T04:11:14.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## v0.10.4-beta.0 (Sat Jan 6 2024)
+
+### 🪄 Improvements
+
+- Improve rule `react/no-unstable-default-props` to support checking for ObjectPatterns within VariableDeclarators that occur on props.
+
 ## v0.10.3 (Fri Jan 5 2024)
 
 ### 🪄 Improvements
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.10.3
+0.10.4-beta.0
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/monorepo",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's monorepo. A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.",
   "keywords": [
     "eslint",
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/core",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's ESLint utility module for static analysis of React core API and Patterns.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-debug/package.json b/packages/plugins/eslint-plugin-debug/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin-debug",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's ESLint plugin for debugging related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-jsx/package.json b/packages/plugins/eslint-plugin-jsx/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin-jsx",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's ESLint plugin for JSX related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-naming-convention/package.json b/packages/plugins/eslint-plugin-naming-convention/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin-naming-convention",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's ESLint plugin for naming convention related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react-hooks/package.json b/packages/plugins/eslint-plugin-react-hooks/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin-react-hooks",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's ESLint plugin for React Hooks related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react/package.json b/packages/plugins/eslint-plugin-react/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/eslint-plugin-react",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's ESLint plugin for React related rules.",
   "homepage": "https://github.com/rel1cx/eslint-react",
   "bugs": {
diff --git a/packages/plugins/eslint-plugin-react/src/rules/no-unstable-default-props.spec.ts b/packages/plugins/eslint-plugin-react/src/rules/no-unstable-default-props.spec.ts
@@ -131,6 +131,49 @@ ruleTester.run(RULE_NAME, rule, {
     dedent`export default function NonComponent({ foo = {} }) {}`,
   ],
   invalid: [
+    {
+      code: dedent`
+        function App({ foo = [], ...rest }) {
+            return null
+        }
+      `,
+      errors: [{
+        messageId: MESSAGE_ID,
+        data: {
+          propName: "foo",
+          forbiddenType: "array expression",
+        },
+      }],
+    },
+    {
+      code: dedent`
+        function App({ foo = {}, ...rest }) {
+            return null
+        }
+      `,
+      errors: [{
+        messageId: MESSAGE_ID,
+        data: {
+          propName: "foo",
+          forbiddenType: "object expression",
+        },
+      }],
+    },
+    {
+      code: dedent`
+        function App(props) {
+            const { foo = [] } = props
+            return null
+        }
+      `,
+      errors: [{
+        messageId: MESSAGE_ID,
+        data: {
+          propName: "foo",
+          forbiddenType: "array expression",
+        },
+      }],
+    },
     {
       code: dedent`
         function App({
diff --git a/packages/plugins/eslint-plugin-react/src/rules/no-unstable-default-props.ts b/packages/plugins/eslint-plugin-react/src/rules/no-unstable-default-props.ts
@@ -1,23 +1,22 @@
+import type { TSESTreeFunction } from "@eslint-react/ast";
 import { NodeType, readableNodeType } from "@eslint-react/ast";
 import { isUnstableAssignmentPattern, useComponentCollector } from "@eslint-react/core";
+import { O } from "@eslint-react/tools";
 import { type TSESTree } from "@typescript-eslint/types";
 import type { ESLintUtils } from "@typescript-eslint/utils";
 import type { ConstantCase } from "string-ts";
+import { match } from "ts-pattern";
 
 import { createRule } from "../utils";
 
 export const RULE_NAME = "no-unstable-default-props";
 
 export type MessageID = ConstantCase<typeof RULE_NAME>;
 
-function hasUsedObjectDestructuringSyntax(
-  params: TSESTree.FunctionExpression["params"],
-): params is [TSESTree.ObjectPattern] {
-  if (params.length !== 1) return false;
-  const [param] = params;
-
-  return param?.type === NodeType.ObjectPattern;
-}
+type ObjectDestructuringDeclarator = TSESTree.VariableDeclarator & {
+  id: TSESTree.ObjectPattern;
+  init: TSESTree.Identifier;
+};
 
 export default createRule<[], MessageID>({
   name: RULE_NAME,
@@ -37,15 +36,39 @@ export default createRule<[], MessageID>({
   defaultOptions: [],
   create(context) {
     const { ctx, listeners } = useComponentCollector(context);
+    const possibleDestructuringDeclarators = new WeakMap<
+      TSESTreeFunction,
+      ObjectDestructuringDeclarator[]
+    >();
 
     return {
       ...listeners,
+      "VariableDeclarator[id.type='ObjectPattern'][init.type='Identifier']"(node: ObjectDestructuringDeclarator) {
+        O.map(
+          ctx.getCurrentFunction(),
+          ([currentFn]) =>
+            possibleDestructuringDeclarators.set(currentFn, [
+              ...possibleDestructuringDeclarators.get(currentFn) ?? [],
+              node,
+            ]),
+        );
+      },
       "Program:exit"(node) {
         const components = ctx.getAllComponents(node);
         for (const { node: component } of components.values()) {
           const { params } = component;
-          if (!hasUsedObjectDestructuringSyntax(params)) continue;
-          const [{ properties }] = params;
+          const [props] = params;
+          if (!props) continue;
+          const properties = match(props)
+            .with({ type: NodeType.ObjectPattern }, ({ properties }) => properties)
+            .with({ type: NodeType.Identifier }, ({ name }) => {
+              const variableDeclarators = possibleDestructuringDeclarators.get(component);
+              if (!variableDeclarators) return [];
+              const declarators = variableDeclarators.filter(d => d.init.name === name);
+
+              return declarators.flatMap(d => d.id.properties);
+            })
+            .otherwise(() => []);
           for (const prop of properties) {
             if (prop.type !== NodeType.Property || prop.value.type !== NodeType.AssignmentPattern) continue;
             const { value } = prop;
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": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's main ESLint plugin. A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.",
   "keywords": [
     "eslint",
diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@eslint-react/shared",
-  "version": "0.10.3",
+  "version": "0.10.4-beta.0",
   "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": "0.10.3",
+  "version": "0.10.4-beta.0",
   "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": "0.10.3",
+  "version": "0.10.4-beta.0",
   "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": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's TSESTree AST primitive 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": "0.10.3",
+  "version": "0.10.4-beta.0",
   "description": "ESLint React's TSESTree AST utility module for static analysis of JSX.",
   "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": "0.10.3",`
	`3`	`+ "version": "0.10.4-beta.0",`
`4`	`4`	`"description": "ESLint React's monorepo. A full TypeScript rewrite of eslint-plugin-react, with well-designed rule behaviors and sensible defaults for modern React apps.",`
`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-react/core",`
`3`		`- "version": "0.10.3",`
	`3`	`+ "version": "0.10.4-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint utility module for static analysis of React core API 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-react/eslint-plugin-debug",`
`3`		`- "version": "0.10.3",`
	`3`	`+ "version": "0.10.4-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for debugging related rules.",`
`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-react/eslint-plugin-jsx",`
`3`		`- "version": "0.10.3",`
	`3`	`+ "version": "0.10.4-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for JSX related rules.",`
`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-react/eslint-plugin-naming-convention",`
`3`		`- "version": "0.10.3",`
	`3`	`+ "version": "0.10.4-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for naming convention related rules.",`
`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-react/eslint-plugin-react-hooks",`
`3`		`- "version": "0.10.3",`
	`3`	`+ "version": "0.10.4-beta.0",`
`4`	`4`	`"description": "ESLint React's ESLint plugin for React Hooks related rules.",`
`5`	`5`	`"homepage": "https://github.com/rel1cx/eslint-react",`
`6`	`6`	`"bugs": {`