@fast-china/eslint-config 1.1.0 → 2.0.0
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/CHANGELOG.md +25 -0
- package/README.md +106 -80
- package/README.zh.md +107 -81
- package/dist/index.d.ts +110 -236
- package/dist/index.js +241 -218
- package/dist/index.js.map +1 -1
- package/dist/rules/index.d.ts +41 -36
- package/dist/rules/index.js +62 -48
- package/dist/rules/index.js.map +1 -1
- package/docs/engineering-audit.zh.md +73 -82
- package/docs/rules-risk.md +33 -44
- package/docs/rules-risk.zh.md +34 -45
- package/package.json +5 -4
package/docs/rules-risk.zh.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
源码中的标记采用以下含义：
|
|
8
8
|
|
|
9
|
-
- `[高影响]
|
|
9
|
+
- `[高影响]`：规则可能产生大面积差异、阻断既有写法，或要求人工确认运行时与公共 API 行为。
|
|
10
10
|
- `[可自动修复]`：当前锁定的 ESLint/插件版本声明该规则可被 `eslint --fix` 修改；不代表无需代码审查。
|
|
11
11
|
- `[安全关注]`：规则主要提示注入、信任边界等安全问题。
|
|
12
12
|
- `[默认关闭]`、`[按需启用]`：规则记录存在，但默认配置不会启用。
|
|
@@ -15,13 +15,13 @@
|
|
|
15
15
|
|
|
16
16
|
## 默认继承的上游预置
|
|
17
17
|
|
|
18
|
-
`
|
|
18
|
+
`fastConfig()` 默认开启 Vue 3、TypeScript、JavaScript、import、RegExp、JSON、Markdown 与 Prettier 兼容层；TypeScript 类型感知和清单排序默认关闭。
|
|
19
19
|
|
|
20
20
|
| 范围 | 默认继承 | 说明 |
|
|
21
21
|
| ---------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
|
22
22
|
| JavaScript | `@eslint/js` 的 `recommended` | 基础语法和运行时正确性，包括 `no-undef`、`no-unused-vars` 等。 |
|
|
23
23
|
| TypeScript | typescript-eslint 的 `recommended` + `stylistic` | 默认不读取类型信息；本库规则在预置之后覆写。 |
|
|
24
|
-
| Vue 3 | `@eslint/js`、typescript-eslint 非类型感知预置、`eslint-plugin-vue` 的 `flat/recommended` | Vue
|
|
24
|
+
| Vue 3 | `@eslint/js`、typescript-eslint 非类型感知预置、`eslint-plugin-vue` 的 `flat/recommended` | 处理 Vue 3 单文件组件，并让 TypeScript 规则正确作用于 `<script lang="ts">`。 |
|
|
25
25
|
| import | `eslint-plugin-import-x` 的 `recommended` | 本库额外配置导入位置、去重和排序。解析器相关规则默认关闭，避免绑定具体别名方案。 |
|
|
26
26
|
| RegExp | `eslint-plugin-regexp` 的 `flat/recommended` | 部分规则可自动改写正则表达式，批量修复后需运行测试。 |
|
|
27
27
|
| JSON/JSONC/JSON5 | `eslint-plugin-jsonc` 对应方言的 `flat/recommended-*` | 三种方言按扩展名隔离，不会互相叠加。 |
|
|
@@ -32,33 +32,32 @@
|
|
|
32
32
|
|
|
33
33
|
## 默认启用的高影响规则
|
|
34
34
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
| 规则 | 等级 | 自动修复 | 主要影响 | 建议
|
|
38
|
-
| --------------------------------------------------- | ---------- | ------------------ | --------------------------------------------------------------------------------------------------- |
|
|
39
|
-
| `
|
|
40
|
-
|
|
|
41
|
-
| `@typescript-eslint/
|
|
42
|
-
| `@typescript-eslint/
|
|
43
|
-
|
|
|
44
|
-
| `
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
49
|
-
| `vue/
|
|
50
|
-
| `vue/
|
|
51
|
-
| `
|
|
52
|
-
|
|
|
53
|
-
| RegExp 推荐预置 | 由上游决定 | 部分规则是 | 可能改写字符类、量词或断言；语法等价不代表业务输入覆盖充分。 | 修复后运行覆盖真实输入的正则测试。 |
|
|
35
|
+
下表覆盖本库主动设置的高影响规则，以及上游默认预置中采用成本较高、最需要审查的规则。
|
|
36
|
+
|
|
37
|
+
| 规则 | 等级 | 自动修复 | 主要影响 | 建议 |
|
|
38
|
+
| --------------------------------------------------- | ---------- | ------------------ | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
|
|
39
|
+
| `import-x/order` | error | 是 | 重排并分组 import。带副作用的裸 import 会被报告但不会安全地自动移动，人工调整顺序可能改变启动行为。 | 先检查入口、polyfill、样式和注册器 import。 |
|
|
40
|
+
| `@typescript-eslint/no-unused-vars` | error | 是（当前插件版本） | 可能删除未使用的 import、变量或声明；以下划线开头是显式保留出口。 | 在独立提交中修复并运行类型检查、构建和测试。 |
|
|
41
|
+
| `@typescript-eslint/consistent-type-imports` | error | 是 | 将纯类型依赖改成内联 `type` import；若原 import 还承担模块副作用，编译后行为可能变化。 | 副作用应改成独立的 `import "module"`，并复核构建产物。 |
|
|
42
|
+
| `@typescript-eslint/no-require-imports` | error | 否 | 阻断 CommonJS、条件加载和部分工具链互操作写法。 | 仅在确实需要的配置文件上按范围关闭，不要全局隐藏。 |
|
|
43
|
+
| `no-var` | error | 是 | 将 `var` 改为块级声明；声明提升和循环闭包行为需要关注。 | 先运行现有测试，重点复核循环内回调。 |
|
|
44
|
+
| `prefer-arrow-callback` | error | 是 | 批量改写回调形式，影响 `this`、`arguments` 或函数名调试体验的代码需要人工确认。 | 检查事件处理器、类库回调和栈追踪。 |
|
|
45
|
+
| `logical-assignment-operators` | error | 是 | 将条件赋值改成 `\|\|=`、`&&=`、`??=`；getter 或 Proxy 场景要确认读取和写入次数。 | 对状态容器和响应式对象运行行为测试。 |
|
|
46
|
+
| `no-restricted-syntax`（`LabeledStatement`） | error | 否 | 禁止 labeled break/continue，可能要求重构多层循环控制流。 | 必要时按文件降级，重构后再恢复。 |
|
|
47
|
+
| `sort-imports` | warn | 是 | 排序同一 import 声明中的成员，通常只产生文本差异。 | 与 `import-x/order` 一起在独立整理提交中执行。 |
|
|
48
|
+
| `vue/require-explicit-emits` | error | 否 | 要求组件声明事件，相当于补全组件公共 API；旧组件可能大量报错。 | 先补齐实际事件清单，不要盲目关闭。 |
|
|
49
|
+
| `vue/no-mutating-props` | error | 否 | 强制单向数据流，可能要求引入本地状态或事件。 | 把修复当作组件设计变更审查。 |
|
|
50
|
+
| `vue/attributes-order` | error | 是 | 首次运行会重排大量模板属性，通常不改变运行逻辑但会形成大 diff。 | 单独提交模板排序，不与业务修改混合。 |
|
|
51
|
+
| `no-unused-vars`、`no-undef`（JavaScript 上游预置） | error | 否 | JavaScript 代码可能出现较多阻断错误；`no-undef` 还会暴露缺失的运行时全局变量声明。 | 正确选择 `environment`，再逐步清理无用代码。 |
|
|
52
|
+
| RegExp 推荐预置 | 由上游决定 | 部分规则是 | 可能改写字符类、量词或断言；语法等价不代表业务输入覆盖充分。 | 修复后运行覆盖真实输入的正则测试。 |
|
|
54
53
|
|
|
55
54
|
另外，`vue/no-v-html` 默认是 `warn`，属于安全关注而非自动重写规则。它提示调用方必须保证 HTML 来自可信来源或经过可靠净化。
|
|
56
55
|
|
|
57
56
|
## 明确不默认启用的高影响能力
|
|
58
57
|
|
|
59
58
|
- TypeScript 和 Vue 的类型感知预置仅在 `typeChecked: true` 时启用；它们会增加项目服务开销，并启用 `no-floating-promises` 等需要类型信息的规则。
|
|
60
|
-
-
|
|
61
|
-
- `
|
|
59
|
+
- 清单排序规则 `jsonc/sort-keys`、`jsonc/sort-array-values` 分别仅在 `sortPackageJson: true`、`sortTsconfig: true` 时启用；首次修复应单独提交并核对发布清单。
|
|
60
|
+
- Lodash 静态导入限制仅在 `lodash: "lodash"` 或 `lodash: "lodash-unified"` 时启用。该策略使用 `no-restricted-imports` 阻止混用包入口，但不会检查动态 `import()` 或 CommonJS `require()`。
|
|
62
61
|
- `import-x/no-unresolved`、`import-x/named` 等依赖 resolver 的检查默认关闭。
|
|
63
62
|
- `package.json` 的 `exports` 条件键永不自动排序。Node 条件导出按键顺序匹配，改写顺序可能改变实际加载文件。
|
|
64
63
|
|
|
@@ -67,38 +66,28 @@
|
|
|
67
66
|
覆盖项必须放在共享配置之后，并尽量限定文件范围：
|
|
68
67
|
|
|
69
68
|
```js
|
|
70
|
-
import {
|
|
69
|
+
import fastChina, { defineRules } from "@fast-china/eslint-config";
|
|
71
70
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
export default defineConfig([
|
|
75
|
-
...createConfig(),
|
|
71
|
+
export default fastChina(
|
|
72
|
+
{},
|
|
76
73
|
{
|
|
77
|
-
name: "project/typescript-
|
|
74
|
+
name: "project/typescript-exceptions",
|
|
78
75
|
files: ["**/*.{ts,tsx,mts,cts,vue}"],
|
|
79
|
-
rules: {
|
|
76
|
+
rules: defineRules({
|
|
80
77
|
"@typescript-eslint/consistent-type-imports": "warn",
|
|
81
78
|
"@typescript-eslint/no-require-imports": "off",
|
|
82
79
|
"@typescript-eslint/no-unused-vars": "warn",
|
|
83
|
-
},
|
|
80
|
+
}),
|
|
84
81
|
},
|
|
85
82
|
{
|
|
86
|
-
name: "project/vue-
|
|
83
|
+
name: "project/vue-exceptions",
|
|
87
84
|
files: ["**/*.vue"],
|
|
88
|
-
rules: {
|
|
85
|
+
rules: defineRules({
|
|
89
86
|
"vue/attributes-order": "warn",
|
|
90
87
|
"vue/require-explicit-emits": "warn",
|
|
91
|
-
},
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
name: "project/json-migration",
|
|
95
|
-
files: ["**/{package.json,tsconfig*.json}"],
|
|
96
|
-
rules: {
|
|
97
|
-
"jsonc/sort-array-values": "off",
|
|
98
|
-
"jsonc/sort-keys": "off",
|
|
99
|
-
},
|
|
100
|
-
},
|
|
101
|
-
]);
|
|
88
|
+
}),
|
|
89
|
+
}
|
|
90
|
+
);
|
|
102
91
|
```
|
|
103
92
|
|
|
104
93
|
建议先执行只读检查，再在独立分支或独立提交中运行 `eslint --fix`。重点审查 import、副作用入口、包导出、组件事件和清单文件，并运行项目的类型检查、构建与测试。
|
package/package.json
CHANGED
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fast-china/eslint-config",
|
|
3
|
-
"version": "
|
|
4
|
-
"
|
|
5
|
-
"description": "A practical ESLint Flat Config for Vue 3, TypeScript, Vite, and JavaScript projects.",
|
|
3
|
+
"version": "2.0.0",
|
|
4
|
+
"description": "Opinionated, typed ESLint Flat Config for Vue 3, Vite, TypeScript, JavaScript, and Node.js.",
|
|
6
5
|
"type": "module",
|
|
7
6
|
"keywords": [
|
|
8
7
|
"fast",
|
|
@@ -25,6 +24,7 @@
|
|
|
25
24
|
},
|
|
26
25
|
"author": "小方",
|
|
27
26
|
"files": [
|
|
27
|
+
"CHANGELOG.md",
|
|
28
28
|
"Fast.png",
|
|
29
29
|
"LICENSE",
|
|
30
30
|
"README.md",
|
|
@@ -96,6 +96,7 @@
|
|
|
96
96
|
"typescript": "^5.9.0"
|
|
97
97
|
},
|
|
98
98
|
"engines": {
|
|
99
|
-
"node": "^
|
|
99
|
+
"node": "^22.13.0 || ^24.0.0",
|
|
100
|
+
"pnpm": "^11.0.0"
|
|
100
101
|
}
|
|
101
102
|
}
|