Skip to content

Commit c9da2e8

Browse files
committed
docs: update README and notable projects using ESLint React
1 parent 2ac27cd commit c9da2e8

File tree

5 files changed

+31
-39
lines changed

5 files changed

+31
-39
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ A set of composable ESLint rules for libraries and frameworks that use React as
1212
- **Comprehensive**: First-class support for TypeScript, React 19, polymorphic components.
1313
- **Advanced Analysis**: Handles complex scenarios and identifies problems that other tools might miss.
1414

15-
## Public packages
15+
## Public Packages
1616

17-
### All-in-one plugins
17+
### All-In-One Plugin
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-
### Modular 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.
@@ -107,11 +107,11 @@ export default tseslint.config({
107107

108108
- [Milestone 2.0 ↗](https://eslint-react.xyz/roadmap#milestone-20)
109109

110-
## Used by
110+
## Notable Projects Using ESLint React
111111

112-
![used-by](https://eslint-react.xyz/used_by.png)
112+
[![used-by](https://eslint-react.xyz/used_by.png)](https://github.com/Rel1cx/eslint-react/blob/main/assets/NOTABLE_PROJECTS_USING_ESLINT_REACT)
113113

114-
### Also available in
114+
## Community ESLint Configs Adopting ESLint React
115115

116116
- [`antfu/eslint-config`](https://github.com/antfu/eslint-config) - Anthony's ESLint config preset.
117117
- [`eslint-config-rebeccastevens`](https://github.com/RebeccaStevens/eslint-config-rebeccastevens) - Rebecca's ESLint config preset.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
https://github.com/ant-design/ant-design
2+
https://github.com/DimensionDev/Maskbook
3+
https://github.com/dream-num/univer
4+
https://github.com/electric-sql/pglite
5+
https://github.com/ensdomains/ensdomains-landing
6+
https://github.com/flirtual/flirtual
7+
https://github.com/hashintel/hash
8+
https://github.com/npmgraph/npmgraph
9+
https://github.com/react-navigation/react-navigation
10+
https://github.com/refined-github/refined-github
11+
https://github.com/RSSNext/Follow
12+
https://github.com/TanStack/query
13+
https://github.com/toss/suspensive
14+
https://github.com/upleveled/eslint-config-upleveled
15+
https://github.com/XYOracleNetwork/sdk-xyo-react-js
16+
https://github.com/zolplay-cn/config-monorepo

packages/plugins/eslint-plugin/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ A set of composable ESLint rules for libraries and frameworks that use React as
1212
- **Comprehensive**: First-class support for TypeScript, React 19, polymorphic components.
1313
- **Advanced Analysis**: Handles complex scenarios and identifies problems that other tools might miss.
1414

15-
## Public packages
15+
## Public Packages
1616

17-
### All-in-one plugins
17+
### All-In-One Plugin
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-
### Modular 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.
@@ -107,11 +107,11 @@ export default tseslint.config({
107107

108108
- [Milestone 2.0 ↗](https://eslint-react.xyz/roadmap#milestone-20)
109109

110-
## Used by
110+
## Notable Projects Using ESLint React
111111

112-
![used-by](https://eslint-react.xyz/used_by.png)
112+
[![used-by](https://eslint-react.xyz/used_by.png)](https://github.com/Rel1cx/eslint-react/blob/main/assets/NOTABLE_PROJECTS_USING_ESLINT_REACT)
113113

114-
### Also available in
114+
## Community ESLint Configs Adopting ESLint React
115115

116116
- [`antfu/eslint-config`](https://github.com/antfu/eslint-config) - Anthony's ESLint config preset.
117117
- [`eslint-config-rebeccastevens`](https://github.com/RebeccaStevens/eslint-config-rebeccastevens) - Rebecca's ESLint config preset.

scripts/build-used-by.ts

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,6 @@ import fs from "node:fs/promises";
44
import { createCanvas, loadImage } from "@napi-rs/canvas";
55
import { ofetch } from "ofetch";
66

7-
const projects = [
8-
"ant-design/ant-design",
9-
"DimensionDev/Maskbook",
10-
"dream-num/univer",
11-
"electric-sql/pglite",
12-
"ensdomains/ensdomains-landing",
13-
"flirtual/flirtual",
14-
"hashintel/hash",
15-
"npmgraph/npmgraph",
16-
"react-navigation/react-navigation",
17-
"refined-github/refined-github",
18-
"RSSNext/Follow",
19-
"TanStack/query",
20-
"toss/suspensive",
21-
"upleveled/eslint-config-upleveled",
22-
"XYOracleNetwork/sdk-xyo-react-js",
23-
"zolplay-cn/config-monorepo",
24-
];
25-
267
interface GitHubRepo {
278
owner: {
289
avatar_url: string;
@@ -77,7 +58,9 @@ async function buildUsedByImage(users: string[]) {
7758
}
7859

7960
const token = process.env["GITHUB_TOKEN"];
80-
const avatars = await Promise.all(projects.map(async (repo) => fetchGitHubAvatar(repo, token)));
61+
const data = await fs.readFile("assets/NOTABLE_PROJECTS_USING_ESLINT_REACT", "utf-8");
62+
const repos = data.trim().split("\n").map((item) => item.replace("https://github.com/", ""));
63+
const avatars = await Promise.all(repos.map(async (repo) => fetchGitHubAvatar(repo, token)));
8164
const img = await buildUsedByImage(avatars);
8265
await fs.writeFile("website/assets/used_by.png", img);
8366
await fs.writeFile("website/public/used_by.png", img);

website/pages/index.mdx

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,6 @@ A set of composable ESLint rules for libraries and frameworks that use React as
3131
- [`eslint-plugin-react-hooks-extra`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-hooks-extra) - Extra React Hooks rules.
3232
- [`eslint-plugin-react-naming-convention`](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-naming-convention) - Naming convention rules.
3333

34-
### Also available in
35-
36-
- [`antfu/eslint-config`](https://github.com/antfu/eslint-config) - Anthony's ESLint config preset.
37-
- [`eslint-config-rebeccastevens`](https://github.com/RebeccaStevens/eslint-config-rebeccastevens) - Rebecca's ESLint config preset.
38-
- [`eslint-config-sheriff`](https://github.com/AndreaPontrandolfo/sheriff) - A comprehensive and opinionated Typescript-first ESLint configuration.
39-
- [`eslint-config-sukka`](https://github.com/SukkaW/eslint-config-sukka) - Sukka's ESLint config preset.
40-
4134
<TweetCards tweets={[
4235
"1865166494709026873",
4336
"1839913920984678890",

0 commit comments

Comments
 (0)