refactor: capitalize "Hooks" in descriptions

Author: Rel1cx

CHANGELOG.md

@@ -247,7 +247,7 @@ function useAuth() {
 
 ### 🐞 Fixes
 
-- `hooks-extra/no-useless-custom-hooks` should allow custom hooks with empty body.
+- `hooks-extra/no-useless-custom-hooks` should allow custom Hooks with empty body.
 
 ### 🪄 Improvements
 

packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-useless-custom-hooks.ts

@@ -27,11 +27,11 @@ export default createRule<[], MessageID>({
   meta: {
     type: "problem",
     docs: {
-      description: "enforce custom hooks to use at least one other hook inside",
+      description: "enforce custom Hooks to use at least one other hook inside",
       [Symbol.for("rule_features")]: RULE_FEATURES,
     },
     messages: {
-      noUselessCustomHooks: "A custom hook '{{name}}' should use at least one other hook.",
+      noUselessCustomHooks: "A custom Hook '{{name}}' should use at least one other hook.",
     },
     schema: [],
   },

packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-event-listener.ts

@@ -145,7 +145,7 @@ export default createRule<[], MessageID>({
     type: "problem",
     docs: {
       description:
-        "enforce that every 'addEventListener' in a component or custom hook has a corresponding 'removeEventListener'.",
+        "enforce that every 'addEventListener' in a component or custom Hook has a corresponding 'removeEventListener'.",
       [Symbol.for("rule_features")]: RULE_FEATURES,
     },
     messages: {

packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-interval.ts

@@ -62,7 +62,7 @@ export default createRule<[], MessageID>({
     type: "problem",
     docs: {
       description:
-        "enforce that every 'setInterval' in a component or custom hook has a corresponding 'clearInterval'.",
+        "enforce that every 'setInterval' in a component or custom Hook has a corresponding 'clearInterval'.",
       [Symbol.for("rule_features")]: RULE_FEATURES,
     },
     messages: {

packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-resize-observer.ts

@@ -92,7 +92,7 @@ export default createRule<[], MessageID>({
   meta: {
     type: "problem",
     docs: {
-      description: "enforce cleanup of 'ResizeObserver' instances in components and custom hooks.",
+      description: "enforce cleanup of 'ResizeObserver' instances in components and custom Hooks.",
       [Symbol.for("rule_features")]: RULE_FEATURES,
     },
     messages: {
@@ -101,7 +101,7 @@ export default createRule<[], MessageID>({
       noLeakedResizeObserverInControlFlow:
         "Dynamically added 'ResizeObserver.observe' should be cleared all at once using 'ResizeObserver.disconnect' in the cleanup function.",
       noLeakedResizeObserverNoFloatingInstance:
-        "A 'ResizeObserver' instance created in component or custom hook must be assigned to a variable for proper cleanup.",
+        "A 'ResizeObserver' instance created in component or custom Hook must be assigned to a variable for proper cleanup.",
     },
     schema: [],
   },

packages/plugins/eslint-plugin-react-web-api/src/rules/no-leaked-timeout.ts

@@ -61,7 +61,7 @@ export default createRule<[], MessageID>({
   meta: {
     type: "problem",
     docs: {
-      description: "enforce that every 'setTimeout' in a component or custom hook has a corresponding 'clearTimeout'.",
+      description: "enforce that every 'setTimeout' in a component or custom Hook has a corresponding 'clearTimeout'.",
       [Symbol.for("rule_features")]: RULE_FEATURES,
     },
     messages: {

packages/shared/src/schemas.ts

@@ -8,7 +8,7 @@ import { array, boolean, instance, object, optional, string } from "valibot";
  * For example, the position of the `deps` argument for the user-defined `useCustomEffect` hook that represents the built-in `useEffect` hook.
  */
 export const CustomHookSchema = object({
-  // TODO: Define the schema for custom hooks
+  // TODO: Define the schema for custom Hooks
 });
 
 /**

website/pages/docs/rules/overview.md

@@ -102,10 +102,10 @@
 
 | Rule                                                             | ✅ | Features | Description                                                       |
 | :--------------------------------------------------------------- | :- | :------- | :---------------------------------------------------------------- |
-| [`no-leaked-event-listener`](web-api-no-leaked-event-listener)   | 1️⃣  | `🔍`     | Prevents leaked `addEventListener` in a component or custom hook. |
-| [`no-leaked-interval`](web-api-no-leaked-interval)               | 1️⃣  | `🔍`     | Prevents leaked `setInterval` in a component or custom hook.      |
-| [`no-leaked-resize-observer`](web-api-no-leaked-resize-observer) | 1️⃣  | `🔍`     | Prevents leaked `ResizeObserver` in a component or custom hook.   |
-| [`no-leaked-timeout`](web-api-no-leaked-timeout)                 | 1️⃣  | `🔍`     | Prevents leaked `setTimeout` in a component or custom hook.       |
+| [`no-leaked-event-listener`](web-api-no-leaked-event-listener)   | 1️⃣  | `🔍`     | Prevents leaked `addEventListener` in a component or custom Hook. |
+| [`no-leaked-interval`](web-api-no-leaked-interval)               | 1️⃣  | `🔍`     | Prevents leaked `setInterval` in a component or custom Hook.      |
+| [`no-leaked-resize-observer`](web-api-no-leaked-resize-observer) | 1️⃣  | `🔍`     | Prevents leaked `ResizeObserver` in a component or custom Hook.   |
+| [`no-leaked-timeout`](web-api-no-leaked-timeout)                 | 1️⃣  | `🔍`     | Prevents leaked `setTimeout` in a component or custom Hook.       |
 
 ## Hooks Extra Rules
 
@@ -115,7 +115,7 @@
 | [`no-direct-set-state-in-use-layout-effect`](hooks-extra-no-direct-set-state-in-use-layout-effect) | 0️⃣  | `🔍`     | Disallow direct calls to the `set` function of `useState` in `useLayoutEffect`. |
 | [`no-unnecessary-use-callback`](hooks-extra-no-unnecessary-use-callback)                           | 0️⃣  | `🔍`     | Disallow unnecessary usage of `useCallback`.                                    |
 | [`no-unnecessary-use-memo`](hooks-extra-no-unnecessary-use-memo)                                   | 0️⃣  | `🔍`     | Disallow unnecessary usage of `useMemo`.                                        |
-| [`no-useless-custom-hooks`](hooks-extra-no-useless-custom-hooks)                                   | 1️⃣  | `🔍`     | Disallow redundant custom hooks definitions.                                    |
+| [`no-useless-custom-hooks`](hooks-extra-no-useless-custom-hooks)                                   | 1️⃣  | `🔍`     | Enforces custom Hooks to use at least one other Hook.                           |
 | [`prefer-use-state-lazy-initialization`](hooks-extra-prefer-use-state-lazy-initialization)         | 1️⃣  | `🔍`     | Warns function calls made inside `useState` calls.                              |
 
 ### Deprecated

website/pages/docs/rules/web-api-no-leaked-event-listener.md

@@ -25,7 +25,7 @@ react-web-api/no-leaked-event-listener
 
 ## What it does
 
-Enforces that every `addEventListener` in a component or custom hook has a corresponding `removeEventListener`.
+Enforces that every `addEventListener` in a component or custom Hook has a corresponding `removeEventListener`.
 
 Adding an event listener without removing it can lead to memory leaks and unexpected behavior. This is because the event listener will continue to exist even after the component or hook is unmounted.
 

website/pages/docs/rules/web-api-no-leaked-interval.md

@@ -25,7 +25,7 @@ react-web-api/no-leaked-interval
 
 ## What it does
 
-Enforces that every `setInterval` in a component or custom hook has a corresponding `clearInterval`.
+Enforces that every `setInterval` in a component or custom Hook has a corresponding `clearInterval`.
 
 Scheduling a interval within the setup function of `useEffect` without canceling it in the cleanup function can lead to unwanted `setInterval` callback executions and may also result in using stale values captured by previous render's effects after each subsequent re-render.