Skip to content

Commit de8599a

Browse files
committed
docs: improve readme and settings docs
1 parent 5d8e569 commit de8599a

File tree

6 files changed

+13
-11
lines changed

6 files changed

+13
-11
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ A series of composable ESLint plugins for libraries and frameworks that use Reac
66

77
## Features
88

9-
- **Universal** rules for libraries and frameworks that use React as a UI runtime.
10-
- **Well designed** rule behaviors and sensible defaults.
11-
- **Maximum flexibility** through minimum rule options.
9+
- **Universal**: Works seamlessly with any library or framework that uses React.
10+
- **Maximum Flexibility**: Achieves extensive capabilities with minimal configuration effort.
11+
- **Advanced Analysis Logic**: Handles complex scenarios and identifies errors that tools like `biome` and `eslint-plugin-react` might miss.
1212

1313
## Public packages
1414

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@eslint-react/monorepo",
33
"version": "1.22.1-beta.1",
44
"private": true,
5-
"description": "Monorepo for eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention].",
5+
"description": "Monorepo for eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention]. The most advanced lint rules for React.",
66
"keywords": [
77
"react",
88
"eslint",

packages/plugins/eslint-plugin/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ A series of composable ESLint plugins for libraries and frameworks that use Reac
66

77
## Features
88

9-
- **Universal** rules for libraries and frameworks that use React as a UI runtime.
10-
- **Well designed** rule behaviors and sensible defaults.
11-
- **Maximum flexibility** through minimum rule options.
9+
- **Universal**: Works seamlessly with any library or framework that uses React.
10+
- **Maximum Flexibility**: Achieves extensive capabilities with minimal configuration effort.
11+
- **Advanced Analysis Logic**: Handles complex scenarios and identifies errors that tools like `biome` and `eslint-plugin-react` might miss.
1212

1313
## Public packages
1414

packages/plugins/eslint-plugin/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@eslint-react/eslint-plugin",
33
"version": "1.22.1-beta.1",
4-
"description": "The main ESLint plugin of ESLint React. Contains all the rules and presets of ESLint React.",
4+
"description": "The main ESLint plugin that contains all the rules from eslint-plugin-react-[x, dom, web-api, hooks-extra, naming-convention].",
55
"keywords": [
66
"react",
77
"eslint",

website/pages/docs/configurations.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ A object of aliases for React built-in hooks. ESLint React will recognize these
6868

6969
An array of user-defined components, used to inform the ESLint React plugins how to treat these components during checks.
7070

71+
This can be incredibly helpful for rules to understand the semantics of user-defined components and their props (e.g. `<Link to="/home" />`, `<Box as="form" />`, `<Button component="a" />`).
72+
7173
## Examples
7274

7375
<ESLintConfigTabs>

website/pages/index.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ A series of composable ESLint plugins for libraries and frameworks that use Reac
99

1010
## Features
1111

12-
- **Universal** rules for libraries and frameworks that use React as a UI runtime.
13-
- **Well designed** rule behaviors and sensible defaults.
14-
- **Maximum flexibility** through minimum rule options.
12+
- **Universal**: Work seamlessly with any library or framework that uses React.
13+
- **Maximum Flexibility**: Achieves extensive capabilities with minimal configuration effort.
14+
- **Advanced Analysis Logic**: Handles complex scenarios and identifies errors that tools like `biome`, `oxc`, and `eslint-plugin-react` can't.
1515

1616
## Public packages
1717

0 commit comments

Comments
 (0)