Skip to content

Commit 1c3a572

Browse files
committed
docs: add implementation details and source links for rules
1 parent b16c5b3 commit 1c3a572

File tree

80 files changed

+480
-3
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

+480
-3
lines changed

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/avoid-shorthand-boolean.md)
24+
1925
## What it does
2026

2127
Enforces the use of explicit boolean values for boolean attributes.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/avoid-shorthand-fragment.md)
24+
1925
## What it does
2026

2127
Enforces the use of explicit `<Fragment>` or `<React.Fragment>` components instead of the shorthand `<>` or `</>` syntax.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/debug-class-component.md)
28+
2329
## What it does
2430

2531
Reports all class components. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/debug-function-component.md)
28+
2329
## What it does
2430

2531
Reports all function components. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/debug-hook.md)
28+
2329
## What it does
2430

2531
Reports all React Hooks. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/debug-is-from-react.md)
28+
2329
## What it does
2430

2531
Reports all identifiers that are initialized from React. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/dom-no-dangerously-set-innerhtml-with-children.md)
31+
2632
## What it does
2733

2834
Disallows `DOM element` using `children` and `dangerouslySetInnerHTML` at the same time.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/dom-no-dangerously-set-innerhtml.md)
27+
2228
## What it does
2329

2430
Warns when using `dangerouslySetInnerHTML`.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/dom-no-find-dom-node.md)
31+
2632
## What it does
2733

2834
This rule disallows the use of `findDOMNode`.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,12 @@ 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+
- [Docs source](https://github.com/Rel1cx/eslint-react/tree/main/website/pages/docs/rules/dom-no-missing-button-type.md)
31+
2632
## What it does
2733

2834
Enforces explicit `type` attribute for `<button>` elements.

0 commit comments

Comments
 (0)