Skip to content

Commit bcbe912

Browse files
committed
docs: minor improvements
1 parent 4b71e30 commit bcbe912

File tree

9 files changed

+13
-17
lines changed

9 files changed

+13
-17
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ A series of composable ESLint rules for React and friends.
4444
- [`eslint-plugin-react-hooks-extra`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-hooks-extra) - Extra React Hooks rules.
4545
- [`eslint-plugin-react-naming-convention`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention) - Naming convention rules.
4646

47-
### All-In-One
47+
### Unified
4848

49-
- [`@eslint-react/eslint-plugin`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin) - Main plugin combining all rules and presets from the above packages.
49+
- [`@eslint-react/eslint-plugin`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin) - A unified plugin that combines all individual plugins into one.
5050

5151
## Installation
5252

apps/website/content/docs/contributing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ This section provides a summary of the packages in the monorepo.
163163
- `packages/plugins/eslint-plugin-react-hooks-extra`: Extra React Hooks rules
164164
- `packages/plugins/eslint-plugin-react-naming-convention`: Naming convention rules
165165
- `packages/plugins/eslint-plugin-react-debug`: Debugging rules for inspecting React patterns in code
166-
- `packages/plugins/eslint-plugin`: Main plugin combining all rules and presets from the above packages
166+
- `packages/plugins/eslint-plugin`: A unified plugin that combines all individual plugins into one
167167

168168
### Documentation
169169

apps/website/content/docs/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Currently, it includes the following:
4343
- [`eslint-plugin-react-hooks-extra`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-hooks-extra) - Extra React Hooks rules.
4444
- [`eslint-plugin-react-naming-convention`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention) - Naming convention rules.
4545
- [`eslint-plugin-react-debug`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-debug) - Debugging rules for inspecting React patterns in code.
46-
- [`@eslint-react/eslint-plugin`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin) - Main plugin combining all rules and presets from the above packages.
46+
- [`@eslint-react/eslint-plugin`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin) - A unified plugin that combines all individual plugins into one.
4747

4848
**Website & Playground**
4949

apps/website/content/docs/getting-started/javascript.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import { Step, Steps } from "fumadocs-ui/components/steps";
77

88
<Callout type="info" title="This instruction requires the following minimum versions:">
99

10-
- `node@18.18.0`
11-
- `eslint@8.57.0`
12-
- `typescript@4.9.5`
10+
- Node.js: `18.18.0`
11+
- ESLint: `8.57.0`
12+
- TypeScript: `4.9.5`
1313

1414
</Callout>
1515

apps/website/content/docs/getting-started/typescript.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import { Step, Steps } from "fumadocs-ui/components/steps";
77

88
<Callout type="info" title="This instruction requires the following minimum versions:">
99

10-
- `node@18.18.0`
11-
- `eslint@8.57.0`
12-
- `typescript@4.9.5`
10+
- Node.js: `18.18.0`
11+
- ESLint: `8.57.0`
12+
- TypeScript: `4.9.5`
1313

1414
</Callout>
1515

packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-direct-set-state-in-use-effect.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,6 @@ The rule **does not flag** indirect calls, such as:
8181
}, []);
8282
```
8383

84-
These limitations may be addressed in the future.
85-
8684
## Examples
8785

8886
The first three cases are common valid use cases because they are not called the `set` function directly in `useEffect`:

packages/plugins/eslint-plugin-react-hooks-extra/src/rules/no-direct-set-state-in-use-layout-effect.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,6 @@ The rule **does not flag** indirect calls, such as:
8181
}, []);
8282
```
8383

84-
These limitations may be addressed in the future.
85-
8684
## Examples
8785

8886
The first three cases are common valid use cases because they are not called the `set` function directly in `useLayoutEffect`:

packages/plugins/eslint-plugin/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ A series of composable ESLint rules for React and friends.
4444
- [`eslint-plugin-react-hooks-extra`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-hooks-extra) - Extra React Hooks rules.
4545
- [`eslint-plugin-react-naming-convention`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention) - Naming convention rules.
4646

47-
### All-In-One
47+
### Unified
4848

49-
- [`@eslint-react/eslint-plugin`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin) - Main plugin combining all rules and presets from the above packages.
49+
- [`@eslint-react/eslint-plugin`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin) - A unified plugin that combines all individual plugins into one.
5050

5151
## Installation
5252

packages/plugins/eslint-plugin/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/eslint-plugin",
33
"version": "1.45.3",
4-
"description": "A series of composable ESLint rules for React and friends.",
4+
"description": "A unified plugin that combines all individual plugins from the eslint-react monorepo into one.",
55
"keywords": [
66
"react",
77
"eslint",

0 commit comments

Comments
 (0)