Skip to content

Commit 72b7120

Browse files
committed
docs: update terminology from mono to modular plugins in documentation
1 parent adddf7f commit 72b7120

File tree

5 files changed

+7
-8
lines changed

5 files changed

+7
-8
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ function useAuth() {
242242

243243
### 🐞 Fixes
244244

245-
- Fixed mono plugins missing default export.
245+
- Fixed modular plugins missing default export.
246246
- Fixed component name detection when the component name starts with a underscore.
247247

248248
### 🪄 Improvements

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A set of composable ESLint rules for libraries and frameworks that use React as
1818

1919
- [`@eslint-react/eslint-plugin`](https://www.npmjs.com/package/@eslint-react/eslint-plugin) - The main ESLint plugin package including all rules and config presets in this repository.
2020

21-
### Mono plugins
21+
### Modular plugins
2222

2323
- [`eslint-plugin-react-x`](https://github.com/rEl1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) - Core rules (renderer-agnostic, compatible with x-platform).
2424
- [`eslint-plugin-react-dom`](https://github.com/rEl1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) - DOM specific rules for React DOM.

packages/plugins/eslint-plugin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A set of composable ESLint rules for libraries and frameworks that use React as
1818

1919
- [`@eslint-react/eslint-plugin`](https://www.npmjs.com/package/@eslint-react/eslint-plugin) - The main ESLint plugin package including all rules and config presets in this repository.
2020

21-
### Mono plugins
21+
### Modular plugins
2222

2323
- [`eslint-plugin-react-x`](https://github.com/rEl1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) - Core rules (renderer-agnostic, compatible with x-platform).
2424
- [`eslint-plugin-react-dom`](https://github.com/rEl1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) - DOM specific rules for React DOM.

website/pages/docs/faq.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,16 @@ Currently, it includes the following plugins:
1818
- `eslint-plugin-react-x` - Core rules (renderer-agnostic, compatible with x-platform).
1919
- `eslint-plugin-react-dom` - DOM specific rules for React DOM.
2020
- `eslint-plugin-react-web-api` - Rules for interacting with Web APIs.
21-
- `eslint-plugin-react-debug` - Debugging rules.
2221
- `eslint-plugin-react-hooks-extra` - Extra React Hooks rules.
2322
- `eslint-plugin-react-naming-convention` - Naming convention rules.
2423

2524
You can view our long-term plans on the [roadmap](/roadmap#plugins-with-ecological-niche-explanation), which includes an explanation of niche explanation for each plugin.
2625

27-
## Is there anything to note about migrating from `eslint-plugin-react` to `eslint-plugin-react-x`?
26+
## Is there anything to note about migrating from `eslint-plugin-react` to `eslint-react`?
2827

29-
Please be aware that some rules may behave differently when transitioning to `eslint-plugin-react-x`. The rules in `eslint-plugin-react-x` are more closely aligned with the guidelines provided by [react.dev](https://react.dev). This alignment is due to `eslint-plugin-react-x` adopting [react.dev](https://react.dev) as its primary reference, rather than `eslint-plugin-react`.
28+
Please be aware that some rules may behave differently when transitioning to `eslint-react`. The rules in `eslint-react` are more closely aligned with the guidelines provided by [react.dev](https://react.dev). This alignment is due to `eslint-react` adopting [react.dev](https://react.dev) as its primary reference, rather than `eslint-plugin-react`.
3029

31-
To smoothly transition, we suggest reviewing the rules in `eslint-plugin-react-x` and running a comprehensive linting check on your codebase to identify and address any discrepancies introduced by the migration.
30+
To smoothly transition, we suggest reviewing the rules in `eslint-react` and running a comprehensive linting check on your codebase to identify and address any discrepancies introduced by the migration.
3231

3332
[¹]: https://github.com/jsx-eslint/eslint-plugin-react/issues/3423#issuecomment-1930936266
3433
[²]: https://github.com/jsx-eslint/eslint-plugin-react/issues/3423#issuecomment-1314565853

website/pages/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ A set of composable ESLint rules for libraries and frameworks that use React as
2323

2424
- [`@eslint-react/eslint-plugin`](https://www.npmjs.com/package/@eslint-react/eslint-plugin) - The main ESLint plugin package including all rules and config presets in this repository.
2525

26-
### Mono plugins
26+
### Modular plugins
2727

2828
- [`eslint-plugin-react-x`](https://github.com/rEl1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) - Core rules (renderer-agnostic, compatible with x-platform).
2929
- [`eslint-plugin-react-dom`](https://github.com/rEl1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) - DOM specific rules for React DOM.

0 commit comments

Comments
 (0)