refactor: rename no-nested-components rule to no-nested-component-definitions and update related documentation

Author: Rel1cx

apps/website/content/docs/deprecated.md

@@ -8,14 +8,15 @@ full: true
 
 | Rule                                                                                                       | Replaced by                                                                          | Deprecated in |
 | :--------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- | :------------ |
-| [`jsx-no-duplicate-props`](/docs/rules/jsx-no-duplicate-props)                                             | [`no-duplicate-jsx-props`](/docs/rules/no-duplicate-jsx-props)                       | 1.22.0        |
-| [`jsx-uses-vars`](/docs/rules/jsx-uses-vars)                                                               | [`use-jsx-vars`](/docs/rules/use-jsx-vars)                                           | 1.22.0        |
 | [`ensure-custom-hooks-using-other-hooks`](/docs/rules/hooks-extra-no-useless-custom-hooks)                 | [`no-useless-custom-hooks`](/docs/rules/hooks-extra-no-useless-custom-hooks)         | 1.13.0        |
 | [`ensure-forward-ref-using-ref`](/docs/rules/ensure-forward-ref-using-ref)                                 | [`no-useless-forward-ref`](/docs/rules/no-useless-forward-ref)                       | 1.33.0        |
 | [`ensure-use-callback-has-non-empty-deps`](/docs/rules/hooks-extra-ensure-use-callback-has-non-empty-deps) | [`no-unnecessary-use-callback`](/docs/rules/hooks-extra-no-unnecessary-use-callback) | 1.13.0        |
 | [`ensure-use-memo-has-non-empty-deps`](/docs/rules/hooks-extra-ensure-use-memo-has-non-empty-deps)         | [`no-unnecessary-use-memo`](/docs/rules/hooks-extra-no-unnecessary-use-memo)         | 1.13.0        |
+| [`jsx-no-duplicate-props`](/docs/rules/jsx-no-duplicate-props)                                             | [`no-duplicate-jsx-props`](/docs/rules/no-duplicate-jsx-props)                       | 1.22.0        |
+| [`jsx-uses-vars`](/docs/rules/jsx-uses-vars)                                                               | [`use-jsx-vars`](/docs/rules/use-jsx-vars)                                           | 1.22.0        |
 | [`no-children-in-void-dom-elements`](/docs/rules/dom-no-children-in-void-dom-elements)                     | [`no-void-elements-with-children`](/docs/rules/dom-no-void-elements-with-children)   | 1.22.0        |
 | [`no-complicated-conditional-rendering`](/docs/rules/no-complicated-conditional-rendering)                 | [`no-complex-conditional-rendering`](/docs/rules/no-complex-conditional-rendering)   | 1.6.0         |
+| [`no-nested-components`](/docs/rules/no-nested-components)                                                 | [`no-nested-component-definitions`](/docs/rules/no-nested-component-definitions)     | 1.34.0        |
 | [`no-redundant-custom-hook`](/docs/rules/hooks-extra-no-useless-custom-hooks)                              | [`no-useless-custom-hooks`](/docs/rules/hooks-extra-no-useless-custom-hooks)         | 1.21.0        |
 
 ## Presets

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

@@ -4,7 +4,6 @@
     "---Core Rules---",
     "avoid-shorthand-boolean",
     "avoid-shorthand-fragment",
-    "no-useless-forward-ref",
     "no-access-state-in-setstate",
     "no-array-index-key",
     "no-children-count",
@@ -32,7 +31,7 @@
     "no-missing-component-display-name",
     "no-missing-context-display-name",
     "no-missing-key",
-    "no-nested-components",
+    "no-nested-component-definitions",
     "no-prop-types",
     "no-redundant-should-component-update",
     "no-set-state-in-component-did-mount",
@@ -47,6 +46,7 @@
     "no-unused-class-component-members",
     "no-unused-state",
     "no-use-context",
+    "no-useless-forward-ref",
     "no-useless-fragment",
     "prefer-destructuring-assignment",
     "prefer-react-namespace-import",

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

@@ -47,7 +47,7 @@ full: true
 | [`no-missing-component-display-name`](./no-missing-component-display-name)           | 0️⃣  | `🔍`          | Enforces that all components have a `displayName` which can be used in devtools.                      |          |
 | [`no-missing-context-display-name`](./no-missing-context-display-name)               | 0️⃣  | `🔍`          | Enforces that all contexts have a `displayName` which React can use as its `displayName` in devtools. |          |
 | [`no-missing-key`](./no-missing-key)                                                 | 2️⃣  | `🔍`          | Prevents missing `key` on items in list rendering.                                                    |          |
-| [`no-nested-components`](./no-nested-components)                                     | 2️⃣  | `🔍`          | Prevents nesting component definitions inside other components.                                       |          |
+| [`no-nested-component-definitions`](./no-nested-component-definitions)               | 2️⃣  | `🔍`          | Prevents nesting component definitions inside other components.                                       |          |
 | [`no-prop-types`](./no-prop-types)                                                   | 2️⃣  | `🔍`          | Prevents using `propTypes` in favor of TypeScript or another type-checking solution.                  |          |
 | [`no-redundant-should-component-update`](./no-redundant-should-component-update)     | 2️⃣  | `🔍`          | Prevents using `shouldComponentUpdate` when extending `React.PureComponent`.                          |          |
 | [`no-set-state-in-component-did-mount`](./no-set-state-in-component-did-mount)       | 1️⃣  | `🔍`          | Prevents calling `this.setState` in `componentDidMount` outside of functions, such as callbacks.      |          |

apps/website/next.config.mjs

@@ -94,6 +94,11 @@ const config = {
         destination: "/docs/rules/no-useless-forward-ref",
         permanent: true,
       },
+      {
+        source: "/docs/rules/no-nested-components",
+        destination: "/docs/rules/no-nested-component-definitions",
+        permanent: true,
+      },
       {
         source: "/docs/rules/dom-no-children-in-void-dom-elements",
         destination: "/docs/rules/dom-no-void-elements-with-children",

eslint.config.ts

@@ -16,7 +16,7 @@ const GLOB_TEST = [
   "**/spec.{ts,tsx,cts,mts}",
   "**/test.{ts,tsx,cts,mts}",
 ];
-// const GLOB_YAML = ["*.{yaml,yml}", "**/*.{yaml,yml}"];
+
 const GLOB_CONFIG = ["*.config.{ts,tsx,cts,mts}", "**/*.config.{ts,tsx,cts,mts}"];
 const GLOB_SCRIPT = ["scripts/**/*.{ts,cts,mts}"];
 const GLOB_IGNORES = [

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

@@ -25,7 +25,7 @@ export const rules = {
   "react-x/no-forward-ref": "warn",
   "react-x/no-implicit-key": "warn",
   "react-x/no-missing-key": "error",
-  "react-x/no-nested-components": "error",
+  "react-x/no-nested-component-definitions": "error",
   "react-x/no-prop-types": "error",
   "react-x/no-redundant-should-component-update": "error",
   "react-x/no-set-state-in-component-did-mount": "warn",

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

@@ -28,7 +28,7 @@ import noLeakedConditionalRendering from "./rules/no-leaked-conditional-renderin
 import noMissingComponentDisplayName from "./rules/no-missing-component-display-name";
 import noMissingContextDisplayName from "./rules/no-missing-context-display-name";
 import noMissingKey from "./rules/no-missing-key";
-import noNestedComponents from "./rules/no-nested-components";
+import noNestedComponentDefinitions from "./rules/no-nested-component-definitions";
 import noPropTypes from "./rules/no-prop-types";
 import noRedundantShouldComponentUpdate from "./rules/no-redundant-should-component-update";
 import noSetStateInComponentDidMount from "./rules/no-set-state-in-component-did-mount";
@@ -87,7 +87,7 @@ export const plugin = {
     "no-missing-component-display-name": noMissingComponentDisplayName,
     "no-missing-context-display-name": noMissingContextDisplayName,
     "no-missing-key": noMissingKey,
-    "no-nested-components": noNestedComponents,
+    "no-nested-component-definitions": noNestedComponentDefinitions,
     "no-prop-types": noPropTypes,
     "no-redundant-should-component-update": noRedundantShouldComponentUpdate,
     "no-set-state-in-component-did-mount": noSetStateInComponentDidMount,
@@ -120,5 +120,7 @@ export const plugin = {
     "jsx-uses-vars": useJsxVars,
     /** @deprecated Use `no-complex-conditional-rendering` instead */
     "no-complicated-conditional-rendering": noComplexConditionalRendering,
+    /** @deprecated Use `no-nested-component-definitions` instead */
+    "no-nested-components-": noNestedComponentDefinitions,
   },
 } as const;

packages/plugins/eslint-plugin-react-x/src/rules/no-nested-components.md renamed to packages/plugins/eslint-plugin-react-x/src/rules/no-nested-component-definitions.md

@@ -1,17 +1,17 @@
 ---
-title: no-nested-components
+title: no-nested-component-definitions
 ---
 
 **Full Name in `eslint-plugin-react-x`**
 
 ```plain copy
-react-x/no-nested-components
+react-x/no-nested-component-definitions
 ```
 
 **Full Name in `@eslint-react/eslint-plugin`**
 
 ```plain copy
-@eslint-react/no-nested-components
+@eslint-react/no-nested-component-definitions
 ```
 
 **Features**
@@ -63,8 +63,8 @@ When a child component needs some data from a parent, [pass it by props](https:/
 
 ## Implementation
 
-- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/no-nested-components.ts)
-- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/no-nested-components.spec.ts)
+- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/no-nested-component-definitions.ts)
+- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/no-nested-component-definitions.spec.ts)
 
 ## Further Reading