@bwt-st/eslint 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,21 +1,81 @@
|
|
|
1
1
|
# @bwt-st/eslint
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
面向现代前端项目的 ESLint Flat Config。包提供基础、Vue 和 React 三个入口，适用于 ESLint 9 及以上版本。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## 安装
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add -D @bwt-st/eslint eslint
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
项目需要使用 ESLint Flat Config，在根目录创建 `eslint.config.js`。
|
|
12
|
+
|
|
13
|
+
## 配置入口
|
|
14
|
+
|
|
15
|
+
| 入口 | 适用项目 | 已包含内容 |
|
|
16
|
+
| ---------------------- | ------------------------------- | -------------------------------------------------- |
|
|
17
|
+
| `@bwt-st/eslint` | 通用 JavaScript/TypeScript 项目 | ESLint 推荐规则、TypeScript 推荐规则和基础全局变量 |
|
|
18
|
+
| `@bwt-st/eslint/vue` | Vue 项目 | 基础配置、Vue Flat Essential 规则和 `.vue` 解析器 |
|
|
19
|
+
| `@bwt-st/eslint/react` | React 项目 | 基础配置和 JSX/TSX 解析支持 |
|
|
20
|
+
|
|
21
|
+
Vue 和 React 入口已经包含基础配置，不需要同时展开基础入口。
|
|
22
|
+
|
|
23
|
+
### 通用项目
|
|
6
24
|
|
|
7
25
|
```js
|
|
26
|
+
// eslint.config.js
|
|
8
27
|
import config from '@bwt-st/eslint'
|
|
9
28
|
|
|
10
29
|
export default config
|
|
11
30
|
```
|
|
12
31
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
Vue 和 React 入口已经包含基础配置，业务项目直接使用对应入口即可：
|
|
32
|
+
### Vue 项目
|
|
16
33
|
|
|
17
34
|
```js
|
|
35
|
+
// eslint.config.js
|
|
18
36
|
import config from '@bwt-st/eslint/vue'
|
|
19
37
|
|
|
20
38
|
export default config
|
|
21
39
|
```
|
|
40
|
+
|
|
41
|
+
### React 项目
|
|
42
|
+
|
|
43
|
+
```js
|
|
44
|
+
// eslint.config.js
|
|
45
|
+
import config from '@bwt-st/eslint/react'
|
|
46
|
+
|
|
47
|
+
export default config
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
运行检查：
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
pnpm exec eslint .
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## 规则与扩展
|
|
57
|
+
|
|
58
|
+
基础配置覆盖 `js`、`mjs`、`cjs`、`ts`、`tsx` 和 `jsx` 文件，并将 `no-console`、`no-debugger` 设置为警告。默认忽略 `dist`、`node_modules`、`coverage` 和 VitePress 构建目录。
|
|
59
|
+
|
|
60
|
+
业务项目可以在共享配置后追加自己的规则：
|
|
61
|
+
|
|
62
|
+
```js
|
|
63
|
+
import config from '@bwt-st/eslint'
|
|
64
|
+
|
|
65
|
+
export default [
|
|
66
|
+
...config,
|
|
67
|
+
{
|
|
68
|
+
rules: {
|
|
69
|
+
'no-console': 'off',
|
|
70
|
+
},
|
|
71
|
+
},
|
|
72
|
+
]
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
React 入口只提供 JSX/TSX 解析和基础规则，不内置 React Hooks、React Refresh 等业务生态插件；需要时请由业务项目按版本自行添加。
|
|
76
|
+
|
|
77
|
+
## 兼容性
|
|
78
|
+
|
|
79
|
+
- Node.js `>=20.19.0`
|
|
80
|
+
- ESLint `^9.0.0 || ^10.0.0`
|
|
81
|
+
- 使用 ESM 配置文件和 Flat Config
|