Skip to content

Commit 262dc32

Browse files
committed
docs: update section orders in rules docs
1 parent e2f72ca commit 262dc32

File tree

80 files changed

+406
-402
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+406
-402
lines changed

website/pages/docs/rules/avoid-shorthand-boolean.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@ react-x/avoid-shorthand-boolean
1616

1717
`🔍` `🔧`
1818

19-
**Implementation**:
20-
21-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-boolean.ts)
22-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-boolean.spec.ts)
23-
2419
## What it does
2520

2621
Enforces the use of explicit boolean values for boolean attributes.
@@ -48,3 +43,8 @@ function Example() {
4843
return <button disabled={true} />;
4944
}
5045
```
46+
47+
## Implementation
48+
49+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-boolean.ts)
50+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-boolean.spec.ts)

website/pages/docs/rules/avoid-shorthand-fragment.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,6 @@ react-x/avoid-shorthand-fragment
1616

1717
`🔍`
1818

19-
**Implementation**:
20-
21-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-fragment.ts)
22-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-fragment.spec.ts)
23-
2419
## What it does
2520

2621
Enforces the use of explicit `<Fragment>` or `<React.Fragment>` components instead of the shorthand `<>` or `</>` syntax.
@@ -56,3 +51,8 @@ function Example() {
5651
);
5752
}
5853
```
54+
55+
## Implementation
56+
57+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-fragment.ts)
58+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x/src/rules/avoid-shorthand-fragment.spec.ts)

website/pages/docs/rules/debug-class-component.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ react-debug/class-component
2020

2121
- `debug`
2222

23-
**Implementation**:
24-
25-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/class-component.ts)
26-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/class-component.spec.ts)
27-
2823
## What it does
2924

3025
Reports all class components. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.
@@ -50,3 +45,8 @@ class Example extends React.PureComponent {
5045
}
5146
}
5247
```
48+
49+
## Implementation
50+
51+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/class-component.ts)
52+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/class-component.spec.ts)

website/pages/docs/rules/debug-function-component.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ react-debug/function-component
2020

2121
- `debug`
2222

23-
**Implementation**:
24-
25-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/function-component.ts)
26-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/function-component.spec.ts)
27-
2823
## What it does
2924

3025
Reports all function components. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.
@@ -56,3 +51,8 @@ import React from "react";
5651

5752
const Example = React.forwardRef(() => <button />);
5853
```
54+
55+
## Implementation
56+
57+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/function-component.ts)
58+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/function-component.spec.ts)

website/pages/docs/rules/debug-hook.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ react-debug/hook
2020

2121
- `debug`
2222

23-
**Implementation**:
24-
25-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/hook.ts)
26-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/hook.spec.ts)
27-
2823
## What it does
2924

3025
Reports all React Hooks. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.
@@ -40,3 +35,8 @@ function useToggle() {
4035
return [value, () => setValue((x) => !x)] as const;
4136
}
4237
```
38+
39+
## Implementation
40+
41+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/hook.ts)
42+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/hook.spec.ts)

website/pages/docs/rules/debug-is-from-react.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ react-debug/is-from-react
2020

2121
- `debug`
2222

23-
**Implementation**:
24-
25-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/debug-is-from-react.ts)
26-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/debug-is-from-react.spec.ts)
27-
2823
## What it does
2924

3025
Reports all identifiers that are initialized from React. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.
@@ -80,3 +75,8 @@ const toArray = Children.toArray;
8075
// | - [initialized from react] name: 'Children', import source: '@pika/react'.
8176
// - [initialized from react] name: 'Children', import source: '@pika/react'.
8277
```
78+
79+
## Implementation
80+
81+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/debug-is-from-react.ts)
82+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/debug-is-from-react.spec.ts)

website/pages/docs/rules/dom-no-dangerously-set-innerhtml-with-children.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,6 @@ react-dom/no-dangerously-set-innerhtml-with-children
2323
- `recommended-typescript`
2424
- `recommended-type-checked`
2525

26-
**Implementation**:
27-
28-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-dangerously-set-innerhtml-with-children.ts)
29-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-dangerously-set-innerhtml-with-children.spec.ts)
30-
3126
## What it does
3227

3328
Disallows `DOM element` using `children` and `dangerouslySetInnerHTML` at the same time.
@@ -59,3 +54,8 @@ function Example() {
5954
return <div dangerouslySetInnerHTML={{ __html: "Hello World" }} />;
6055
}
6156
```
57+
58+
## Implementation
59+
60+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-dangerously-set-innerhtml-with-children.ts)
61+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-dangerously-set-innerhtml-with-children.spec.ts)

website/pages/docs/rules/dom-no-dangerously-set-innerhtml.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,6 @@ react-dom/no-dangerously-set-innerhtml
1919
- `recommended-typescript`
2020
- `recommended-type-checked`
2121

22-
**Implementation**:
23-
24-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-dangerously-set-innerhtml.ts)
25-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-dangerously-set-innerhtml.spec.ts)
26-
2722
## What it does
2823

2924
Warns when using `dangerouslySetInnerHTML`.
@@ -43,3 +38,8 @@ function Example() {
4338
return <div dangerouslySetInnerHTML={{ __html: "Hello, World!" }} />;
4439
}
4540
```
41+
42+
## Implementation
43+
44+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-dangerously-set-innerhtml.ts)
45+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-dangerously-set-innerhtml.spec.ts)

website/pages/docs/rules/dom-no-find-dom-node.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,6 @@ react-dom/no-find-dom-node
2323
- `recommended-typescript`
2424
- `recommended-type-checked`
2525

26-
**Implementation**:
27-
28-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-find-dom-node.ts)
29-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-find-dom-node.spec.ts)
30-
3126
## What it does
3227

3328
This rule disallows the use of `findDOMNode`.
@@ -76,6 +71,11 @@ class AutoSelectingInput extends Component {
7671
}
7772
```
7873

74+
## Implementation
75+
76+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-find-dom-node.ts)
77+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom/src/rules/no-find-dom-node.spec.ts)
78+
7979
## Further Reading
8080

8181
- [React: APIs findDOMNode](https://react.dev/reference/react-dom/findDOMNode)

website/pages/docs/rules/dom-no-missing-button-type.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,6 @@ react-dom/no-missing-button-type
2323
- `recommended-typescript`
2424
- `recommended-type-checked`
2525

26-
**Implementation**:
27-
28-
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-missing-button-type.ts)
29-
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-missing-button-type.spec.ts)
30-
3126
## What it does
3227

3328
Enforces explicit `type` attribute for `button` elements.
@@ -60,6 +55,11 @@ function Example() {
6055
}
6156
```
6257

58+
## Implementation
59+
60+
- [Rule source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-missing-button-type.ts)
61+
- [Test source](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug/src/rules/dom-no-missing-button-type.spec.ts)
62+
6363
## Further Reading
6464

6565
- [MDN: button - notes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#notes)

0 commit comments

Comments
 (0)