feat: add 'jsx-key-before-spread'

Author: Rel1cx

apps/website/content/docs/rules/meta.json

@@ -2,6 +2,7 @@
   "pages": [
     "overview",
     "---X Rules---",
+    "jsx-key-before-spread",
     "jsx-no-comment-textnodes",
     "jsx-no-duplicate-props",
     "jsx-no-undef",

apps/website/content/docs/rules/overview.mdx

@@ -31,6 +31,7 @@ The `jsx-*` rules check for issues exclusive to JSX syntax, which are absent fro
 
 | Rule                                                                                     | ✅  |    🌟     | Description                                                                                         | `react`  |
 | :-----------------------------------------------------------------------------------     | :-- | :-------: | :-------------------------------------------------------------------------------------------------- | :------: |
+| [`jsx-key-before-spread`](./jsx-key-before-spread)                                       | 1️⃣  |           | Enforces that the `key` attribute is placed before the spread attribute in JSX elements             |          |
 | [`jsx-no-comment-textnodes`](./jsx-no-comment-textnodes)                                 | 1️⃣  |           | Prevents comments from being inserted as text nodes                                                 |          |
 | [`jsx-no-duplicate-props`](./jsx-no-duplicate-props)                                     | 1️⃣  |           | Disallow duplicate props in JSX elements                                                            |          |
 | [`jsx-no-undef`](./jsx-no-undef)                                                         | 0️⃣  |           | Disallow undefined variables in JSX elements                                                        |          |

package.json

@@ -87,7 +87,7 @@
     "tsup": "^8.4.0",
     "tsx": "^4.19.4",
     "type-fest": "^4.40.1",
-    "typedoc": "^0.28.3",
+    "typedoc": "^0.28.4",
     "typedoc-plugin-markdown": "^4.6.3",
     "typedoc-plugin-mdn-links": "^5.0.1",
     "typescript": "^5.8.3",

packages/plugins/eslint-plugin-react-x/src/configs/recommended.ts

@@ -5,6 +5,7 @@ export const name = "react-x/recommended";
 
 export const rules = {
   "react-x/jsx-no-comment-textnodes": "warn",
+  "react-x/jsx-key-before-spread": "warn",
   "react-x/jsx-no-duplicate-props": "warn",
   // "react-x/jsx-no-undef": "error",
   "react-x/jsx-uses-react": "warn",

packages/plugins/eslint-plugin-react-x/src/plugin.ts

@@ -1,4 +1,5 @@
 import { name, version } from "../package.json";
+import jsxKeyBeforeSpread from "./rules/jsx-key-before-spread";
 import jsxNoCommentTextnodes from "./rules/jsx-no-comment-textnodes";
 import jsxNoDuplicateProps from "./rules/jsx-no-duplicate-props";
 import jsxNoUndef from "./rules/jsx-no-undef";
@@ -64,6 +65,7 @@ export const plugin = {
     version,
   },
   rules: {
+    "jsx-key-before-spread": jsxKeyBeforeSpread,
     "jsx-no-comment-textnodes": jsxNoCommentTextnodes,
     "jsx-no-duplicate-props": jsxNoDuplicateProps,
     "jsx-no-undef": jsxNoUndef,

packages/plugins/eslint-plugin-react-x/src/rules/jsx-key-before-spread.md

@@ -0,0 +1,51 @@
+---
+title: jsx-key-before-spread
+---
+
+**Full Name in `eslint-plugin-react-x`**
+
+```sh copy
+react-x/jsx-key-before-spread
+```
+
+**Full Name in `@eslint-react/eslint-plugin`**
+
+```sh copy
+@eslint-react/jsx-key-before-spread
+```
+
+**Presets**
+
+- `x`
+- `recommended`
+- `recommended-typescript`
+- `recommended-type-checked`
+
+## Description
+
+Enforces that the `key` attribute is placed before the spread attribute in JSX elements.
+
+When using the JSX automatic runtime, `key` is a special attribute in the JSX transform. See the [Babel repl](https://babeljs.io/repl#?browsers=last%202%20chrome%20versions&build=&builtIns=false&corejs=3.21&spec=false&loose=false&code_lz=DwEwlgbgBA1gpgTwLwCICMKoG8B0eAOATgPb4DOAvlAPQB8A3AFCiTZ45GmWyKoBMmOkxbR4yFAGZMAYwA2AQzJkAcvIC2cVIIbNw0OYpXrNKTGNRSaDIA&forceAllTransforms=false&modules=false&shippedProposals=false&evaluate=true&fileSize=false&timeTravel=false&sourceType=module&lineWrap=true&presets=react&prettier=false&targets=&version=7.27.0&externalPlugins=&assumptions=%7B%7D) and [TypeScript playground](https://www.typescriptlang.org/play/?target=99&jsx=4#code/DwEwlgbgBA1gpgTwLwCICMKoG8B0eAOATgPb4DOAvlAPQB8A3ALABQok2eORplsiqAJkx0mrcNHjIUAZkwBjADYBDMmQBySgLZxUwhizbRFK9Vp0pMk1ABY99IA)
+
+If the `key` prop is _before_ any spread props, it is passed as the `key` argument of the `_jsx` / `_jsxs` / `_jsxDev` function. But if the `key` prop is _after_ spread props, The compiler uses `createElement` instead and passes `key` as a regular prop.
+
+## Examples
+
+### Failing
+
+```tsx
+<div {...props} key="2" />;
+```
+
+### Passing
+
+```tsx
+<div key="1" {...props} />;
+<div key="3" className="" />;
+<div className="" key="3" />;
+```
+
+## Implementation
+
+- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/jsx-key-before-spread.ts)
+- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/jsx-key-before-spread.spec.ts)

packages/plugins/eslint-plugin-react-x/src/rules/jsx-key-before-spread.spec.ts

@@ -0,0 +1,64 @@
+import tsx from "dedent";
+
+import { allValid, ruleTester } from "../../../../../test";
+import rule, { RULE_NAME } from "./jsx-key-before-spread";
+
+ruleTester.run(RULE_NAME, rule, {
+  invalid: [
+    {
+      code: tsx`
+        const App = (props) => {
+            return [
+                    <div {...props} key="1">1</div>,
+                    <div {...props} key="1">2</div>,
+                    <div {...props} key="1">3</div>,
+                 ]
+        };
+      `,
+      errors: [
+        { messageId: "jsxKeyBeforeSpread" },
+        { messageId: "jsxKeyBeforeSpread" },
+        { messageId: "jsxKeyBeforeSpread" },
+      ],
+    },
+    {
+      code: tsx`
+
+        const App = (props) => {
+        return [
+                <div {...props} key="1">1</div>,
+                <div {...props} key="1">2</div>,
+                <div {...props} key="1">3</div>,
+              ]
+          };
+      `,
+      errors: [
+        { messageId: "jsxKeyBeforeSpread" },
+        { messageId: "jsxKeyBeforeSpread" },
+        { messageId: "jsxKeyBeforeSpread" },
+      ],
+    },
+  ],
+  valid: [
+    ...allValid,
+    tsx`
+      const App = (props) => {
+          return [<div key="1">1</div>]
+      };
+    `,
+    tsx`
+      const App = (props) => {
+          return [
+                  <div key="1" {...props}>1</div>,
+                  <div key="2" {...props}>2</div>,
+                  <div key="3" {...props}>3</div>,
+               ]
+      };
+    `,
+    tsx`
+      const App = (props) => {
+          return [1, 2, 3].map((item) => <div key={Math.random()}>{item}</div>)
+      };
+    `,
+  ],
+});

packages/plugins/eslint-plugin-react-x/src/rules/jsx-key-before-spread.ts

@@ -0,0 +1,51 @@
+import type { RuleContext, RuleFeature } from "@eslint-react/kit";
+import type { RuleListener } from "@typescript-eslint/utils/ts-eslint";
+import type { CamelCase } from "string-ts";
+
+import { AST_NODE_TYPES as T } from "@typescript-eslint/types";
+import { createRule } from "../utils";
+
+export const RULE_NAME = "jsx-key-before-spread";
+
+export const RULE_FEATURES = [
+  "EXP",
+] as const satisfies RuleFeature[];
+
+export type MessageID = CamelCase<typeof RULE_NAME>;
+
+export default createRule<[], MessageID>({
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Enforces that the 'key' attribute is placed before the spread attribute in JSX elements.",
+      [Symbol.for("rule_features")]: RULE_FEATURES,
+    },
+    messages: {
+      jsxKeyBeforeSpread: "The 'key' attribute must be placed before the spread attribute.",
+    },
+    schema: [],
+  },
+  name: RULE_NAME,
+  create,
+  defaultOptions: [],
+});
+
+export function create(context: RuleContext<MessageID, []>): RuleListener {
+  return {
+    JSXOpeningElement(node) {
+      let firstSpreadAttributeIndex: null | number = null;
+      for (const [index, attr] of node.attributes.entries()) {
+        if (attr.type === T.JSXSpreadAttribute) {
+          firstSpreadAttributeIndex ??= index;
+          continue;
+        }
+        if (attr.name.name === "key" && firstSpreadAttributeIndex != null && index > firstSpreadAttributeIndex) {
+          context.report({
+            messageId: "jsxKeyBeforeSpread",
+            node: attr,
+          });
+        }
+      }
+    },
+  };
+}

packages/plugins/eslint-plugin/src/configs/x.ts

@@ -6,6 +6,7 @@ export const name = "@eslint-react/x";
 
 export const rules = {
   "@eslint-react/jsx-no-comment-textnodes": "warn",
+  "@eslint-react/jsx-key-before-spread": "warn",
   "@eslint-react/jsx-no-duplicate-props": "warn",
   // "@eslint-react/jsx-no-undef": "error",
   "@eslint-react/jsx-uses-react": "warn",