docs: minor updates

Rel1cx · Rel1cx · commit d7a7b062ce66 · 2024-12-07T07:11:40.000+08:00
diff --git a/packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-redundant-custom-hook.ts b/packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-redundant-custom-hook.ts
@@ -11,7 +11,7 @@ export type MessageID = CamelCase<typeof RULE_NAME>;
 // Hooks that are not call other hooks are redundant
 // In React, hooks are like colored functions, and defining a custom hook that doesn't call other hooks is like defining a generator function that doesn't yield or an async function that doesn't await.
 // "Custom Hooks may call other Hooks (that’s their whole purpose)." from https://react.dev/warnings/invalid-hook-call-warning
-// Further Reading: https://react.dev/learn/reusing-logic-with-custom-hooks#should-all-functions-called-during-rendering-start-with-the-use-prefix
+// Further reading: https://react.dev/learn/reusing-logic-with-custom-hooks#should-all-functions-called-during-rendering-start-with-the-use-prefix
 export default createRule<[], MessageID>({
   meta: {
     type: "problem",
diff --git a/website/pages/docs/rules/dom-no-find-dom-node.mdx b/website/pages/docs/rules/dom-no-find-dom-node.mdx
@@ -54,6 +54,6 @@ class AutoSelectingInput extends Component {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: APIs findDOMNode](https://react.dev/reference/react-dom/findDOMNode)
diff --git a/website/pages/docs/rules/dom-no-missing-button-type.mdx b/website/pages/docs/rules/dom-no-missing-button-type.mdx
@@ -35,6 +35,6 @@ function Example() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: button - notes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#notes)
diff --git a/website/pages/docs/rules/dom-no-missing-iframe-sandbox.mdx b/website/pages/docs/rules/dom-no-missing-iframe-sandbox.mdx
@@ -38,6 +38,6 @@ function Example() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: iframe - sandbox](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attributes)
diff --git a/website/pages/docs/rules/dom-no-render-return-value.mdx b/website/pages/docs/rules/dom-no-render-return-value.mdx
@@ -38,6 +38,6 @@ function doSomethingWithInst(inst: HTMLDivElement | null) {
 ReactDOM.render(<div id="app" ref={doSomethingWithInst} />, document.body);
 ```
 
-## Further Reading
+## Further reading
 
 - [Legacy React: react-dom/render](https://legacy.reactjs.org/docs/react-dom.html#render)
diff --git a/website/pages/docs/rules/dom-no-unsafe-iframe-sandbox.mdx b/website/pages/docs/rules/dom-no-unsafe-iframe-sandbox.mdx
@@ -41,6 +41,6 @@ function Example() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: iframe - sandbox](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attributes)
diff --git a/website/pages/docs/rules/ensure-forward-ref-using-ref.mdx b/website/pages/docs/rules/ensure-forward-ref-using-ref.mdx
@@ -38,6 +38,6 @@ const Example = React.forwardRef<HTMLButtonElement>((props, ref) => {
 });
 ```
 
-## Further Reading
+## Further reading
 
 - [React: forwardRef](https://react.dev/reference/react/forwardRef)
diff --git a/website/pages/docs/rules/hooks-extra-no-direct-set-state-in-use-effect.mdx b/website/pages/docs/rules/hooks-extra-no-direct-set-state-in-use-effect.mdx
@@ -237,7 +237,7 @@ function List({ items }) {
 
 The limitation may be lifted in the future.
 
-### Further Reading
+### Further reading
 
 - [React: useState](https://react.dev/reference/react/useState#setstate)
 - [React: useEffect](https://react.dev/reference/react/useEffect)
diff --git a/website/pages/docs/rules/hooks-extra-no-direct-set-state-in-use-layout-effect.mdx b/website/pages/docs/rules/hooks-extra-no-direct-set-state-in-use-layout-effect.mdx
@@ -237,7 +237,7 @@ function List({ items }) {
 
 The limitation may be lifted in the future.
 
-### Further Reading
+### Further reading
 
 - [React: useState](https://react.dev/reference/react/useState#setstate)
 - [React: useLayoutEffect](https://react.dev/reference/react/useLayoutEffect)
diff --git a/website/pages/docs/rules/hooks-extra-no-redundant-custom-hook.mdx b/website/pages/docs/rules/hooks-extra-no-redundant-custom-hook.mdx
@@ -44,7 +44,7 @@ function useCounter() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: invalid-hook-call-warning (the first note)](https://react.dev/warnings/invalid-hook-call-warning)
 - [React: should-all-functions-called-during-rendering-start-with-the-use-prefix (the deep dive)](https://react.dev/learn/reusing-logic-with-custom-hooks#should-all-functions-called-during-rendering-start-with-the-use-prefix)
diff --git a/website/pages/docs/rules/hooks-extra-prefer-use-state-lazy-initialization.mdx b/website/pages/docs/rules/hooks-extra-prefer-use-state-lazy-initialization.mdx
@@ -47,6 +47,6 @@ function Example() {
 declare function generateTodos(): string[];
 ```
 
-## Further Reading
+## Further reading
 
 - [Official React documentation on useState](https://react.dev/reference/react/useState)
diff --git a/website/pages/docs/rules/no-array-index-key.mdx b/website/pages/docs/rules/no-array-index-key.mdx
@@ -56,6 +56,6 @@ function Example({ items }: ExampleProps) {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Why does React need keys?](https://react.dev/learn/rendering-lists#why-does-react-need-keys)
diff --git a/website/pages/docs/rules/no-class-component.mdx b/website/pages/docs/rules/no-class-component.mdx
@@ -48,6 +48,6 @@ function Example({ name }: ExampleProps) {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Legacy React APIs Component](https://react.dev/reference/react/Component)
diff --git a/website/pages/docs/rules/no-clone-element.mdx b/website/pages/docs/rules/no-clone-element.mdx
@@ -28,6 +28,6 @@ const clonedElement = cloneElement(
 console.log(clonedElement); // <Row title="Cabbage" isHighlighted={true}>Goodbye</Row>
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Legacy React APIs cloneElement](https://react.dev/reference/react/cloneElement)
diff --git a/website/pages/docs/rules/no-component-will-mount.mdx b/website/pages/docs/rules/no-component-will-mount.mdx
@@ -48,6 +48,6 @@ class Example extends React.Component<ExampleProps> {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Legacy React APIs componentWillMount](https://react.dev/reference/react/Component#componentwillmount)
diff --git a/website/pages/docs/rules/no-component-will-receive-props.mdx b/website/pages/docs/rules/no-component-will-receive-props.mdx
@@ -40,6 +40,6 @@ class Example extends React.Component {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Legacy React APIs componentWillReceiveProps](https://react.dev/reference/react/Component#componentwillreceiveprops)
diff --git a/website/pages/docs/rules/no-component-will-update.mdx b/website/pages/docs/rules/no-component-will-update.mdx
@@ -40,6 +40,6 @@ class ExampleComponent extends React.Component {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Legacy React APIs componentWillUpdate](https://react.dev/reference/react/Component#componentwillupdate)
diff --git a/website/pages/docs/rules/no-create-ref.mdx b/website/pages/docs/rules/no-create-ref.mdx
@@ -49,6 +49,6 @@ class Example extends React.Component {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Legacy React APIs createRef](https://react.dev/reference/react/createRef)
diff --git a/website/pages/docs/rules/no-duplicate-key.mdx b/website/pages/docs/rules/no-duplicate-key.mdx
@@ -42,6 +42,6 @@ function Example () {
 };
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Why does React need keys?](https://react.dev/learn/rendering-lists#why-does-react-need-keys)
diff --git a/website/pages/docs/rules/no-forward-ref.mdx b/website/pages/docs/rules/no-forward-ref.mdx
@@ -34,7 +34,7 @@ function MyInput({ ref, ...props }) {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: APIs forwardRef](https://react.dev/reference/react/forwardRef)
 - [React: ref as a prop](https://react.dev/blog/2024/12/05/react-19#ref-as-a-prop)
diff --git a/website/pages/docs/rules/no-leaked-conditional-rendering.mdx b/website/pages/docs/rules/no-leaked-conditional-rendering.mdx
@@ -245,6 +245,6 @@ declare const List: React.ComponentType<{ items: string[] }>;
 declare const EmptyList: React.ComponentType;
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Conditional Rendering](https://react.dev/learn/conditional-rendering)
diff --git a/website/pages/docs/rules/no-missing-key.mdx b/website/pages/docs/rules/no-missing-key.mdx
@@ -60,6 +60,6 @@ function Example({ items }: ExampleProps) {
 declare const Todo: React.ComponentType<{ id: number; name: string }>;
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Why does React need keys?](https://react.dev/learn/rendering-lists#why-does-react-need-keys)
diff --git a/website/pages/docs/rules/no-nested-components.mdx b/website/pages/docs/rules/no-nested-components.mdx
@@ -42,6 +42,6 @@ function Profile() {
 
 When a child component needs some data from a parent, [pass it by props](https://react.dev/learn/passing-props-to-a-component) instead of nesting definitions.
 
-## Further Reading
+## Further reading
 
 - [React: Nesting and organizing components](https://react.dev/learn/your-first-component#nesting-and-organizing-components)
diff --git a/website/pages/docs/rules/no-prop-types.mdx b/website/pages/docs/rules/no-prop-types.mdx
@@ -86,6 +86,6 @@ function ExampleComponent({ name }: ExampleComponentProps) {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React Blog: React 19 RC Upgrade Guide - Removed: `propTypes` and `defaultProps` for functions](https://react.dev/blog/2024/04/25/react-19-upgrade-guide#removed-proptypes-and-defaultprops)
diff --git a/website/pages/docs/rules/no-useless-fragment.mdx b/website/pages/docs/rules/no-useless-fragment.mdx
@@ -133,7 +133,7 @@ const cat = <>meow</>
 <Fragment key={item.id}>{item.value}</Fragment>
 ```
 
-## Further Reading
+## Further reading
 
 - [React: Fragment](https://react.dev/reference/react/Fragment)
 - [React: Preserving and Resetting State](https://react.dev/learn/preserving-and-resetting-state)
diff --git a/website/pages/docs/rules/prefer-destructuring-assignment.mdx b/website/pages/docs/rules/prefer-destructuring-assignment.mdx
@@ -84,7 +84,7 @@ function Example({ items, ...rest }: ExampleProps) {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: Destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment)
 - [React: passing-props-to-a-component](https://react.dev/learn/passing-props-to-a-component#step-2-read-props-inside-the-child-component)
diff --git a/website/pages/docs/rules/prefer-read-only-props.mdx b/website/pages/docs/rules/prefer-read-only-props.mdx
@@ -64,6 +64,6 @@ function Example(props: Props) {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [React: passing-props-to-a-component#recap](https://react.dev/learn/passing-props-to-a-component#recap)
diff --git a/website/pages/docs/rules/web-api-no-leaked-event-listener.mdx b/website/pages/docs/rules/web-api-no-leaked-event-listener.mdx
@@ -232,7 +232,7 @@ function useCustomHook() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: EventTarget.addEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener)
 - [MDN: EventTarget.removeEventListener](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/removeEventListener)
diff --git a/website/pages/docs/rules/web-api-no-leaked-interval.mdx b/website/pages/docs/rules/web-api-no-leaked-interval.mdx
@@ -49,7 +49,7 @@ function Example() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: setInterval](https://developer.mozilla.org/en-US/docs/Web/API/setInterval)
 - [MDN: clearInterval](https://developer.mozilla.org/en-US/docs/Web/API/clearInterval)
diff --git a/website/pages/docs/rules/web-api-no-leaked-resize-observer.mdx b/website/pages/docs/rules/web-api-no-leaked-resize-observer.mdx
@@ -53,7 +53,7 @@ function Example() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: ResizeObserver](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver)
 - [React: Connecting to an external system](https://react.dev/reference/react/useEffect#connecting-to-an-external-system)
diff --git a/website/pages/docs/rules/web-api-no-leaked-timeout.mdx b/website/pages/docs/rules/web-api-no-leaked-timeout.mdx
@@ -49,7 +49,7 @@ function Example() {
 }
 ```
 
-## Further Reading
+## Further reading
 
 - [MDN: setTimeout](https://developer.mozilla.org/en-US/docs/Web/API/setTimeout)
 - [MDN: clearTimeout](https://developer.mozilla.org/en-US/docs/Web/API/clearTimeout)

Original file line number	Diff line number	Diff line change
`@@ -54,6 +54,6 @@ class AutoSelectingInput extends Component {`
`54`	`54`	`}`
`55`	`55`	```
`56`	`56`
`57`		`-## Further Reading`
	`57`	`+## Further reading`
`58`	`58`
`59`	`59`	`- [React: APIs findDOMNode](https://react.dev/reference/react-dom/findDOMNode)`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,6 @@ function Example() {`
`35`	`35`	`}`
`36`	`36`	```
`37`	`37`
`38`		`-## Further Reading`
	`38`	`+## Further reading`
`39`	`39`
`40`	`40`	`- [MDN: button - notes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#notes)`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,6 @@ function Example() {`
`38`	`38`	`}`
`39`	`39`	```
`40`	`40`
`41`		`-## Further Reading`
	`41`	`+## Further reading`
`42`	`42`
`43`	`43`	`- [MDN: iframe - sandbox](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attributes)`
Original file line number	Diff line number	Diff line change
`@@ -41,6 +41,6 @@ function Example() {`
`41`	`41`	`}`
`42`	`42`	```
`43`	`43`
`44`		`-## Further Reading`
	`44`	`+## Further reading`
`45`	`45`
`46`	`46`	`- [MDN: iframe - sandbox](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe#attributes)`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ function useCounter() {`
`44`	`44`	`}`
`45`	`45`	```
`46`	`46`
`47`		`-## Further Reading`
	`47`	`+## Further reading`
`48`	`48`
`49`	`49`	`- [React: invalid-hook-call-warning (the first note)](https://react.dev/warnings/invalid-hook-call-warning)`
`50`	`50`	`- [React: should-all-functions-called-during-rendering-start-with-the-use-prefix (the deep dive)](https://react.dev/learn/reusing-logic-with-custom-hooks#should-all-functions-called-during-rendering-start-with-the-use-prefix)`