把以下.eslintrc.js转化为eslint.config.js// 1. 模块导入 // 修改 ESLint 的默认模块解析逻辑,使其支持现代 JavaScript 模块解析方式 require('@rushstack/eslint-patch/modern-module-resolution') // 2. 基础配置 module.exports = { root: true, // 表示当前目录是 ESLint 配置的根目录 extends: [ 'plugin:vue/vue3-essential', // Vue 3 的基础规则 'eslint:recommended', // ESLint 的推荐规则 '@vue/eslint-config-prettier/skip-formatting' // 禁用与 Prettier 冲突的格式化规则 ], // 继承以下规则集 parserOptions: { ecmaVersion: 'latest' // 支持最新的 ECMAScript 特性 }, // 3. 自定义规则 rules: { // (1) Prettier 集成 'prettier/prettier': [ 'warn', { singleQuote: true, // 单引号 semi: false, // 无分号 printWidth: 100, // 每行宽度至多100字符(默认 80) trailingComma: 'none', // 对象|数组最后不加逗号 endOfLine: 'auto' // 自动处理换行符(兼容 Windows/macOS) } ], // 将 Prettier 的规则作为 ESLint 规则执行,不符合格式时会触发警告('warn') // (2) Vue 组件命名 'vue/multi-word-component-names': [ 'warn', { ignores: ['index'] // vue组件名称多单词组成(忽略index.vue) } ], // (3) 禁用不规则空格检查 'no-irregular-whitespace': 'off' // 关闭对不可见空格的检查 } }
时间: 2025-07-20 20:29:58 AIGC 浏览: 36
<think>我们正在将旧的 `.eslintrc.js`(CommonJS 格式)转换为新的 `eslint.config.js`(Flat Config 格式)。新的 Flat Config 格式是 ESLint v9 引入的,它使用 ESM 语法,并且配置结构是一个数组,每个元素是一个配置对象。
原配置分析:
1. 使用了 `@rushstack/eslint-patch/modern-module-resolution` 补丁,用于解决模块解析问题。
2. 配置了 `root: true`,表示该配置是根配置。
3. 继承的规则集(extends):
- `plugin:vue/vue3-essential`
- `eslint:recommended`
- `@vue/eslint-config-prettier/skip-formatting`
4. 解析选项(parserOptions): `ecmaVersion: 'latest'`
5. 自定义规则(rules):
- `prettier/prettier`: 配置了 Prettier 的规则,包括单引号、无分号、行宽100、无尾随逗号、自动换行符。
- `vue/multi-word-component-names`: 配置了 Vue 组件多单词名称规则,忽略 `index`。
- `no-irregular-whitespace`: 关闭。
转换步骤:
1. 安装必要的依赖:由于新的配置格式需要,我们需要确保安装了正确的插件。
- `@eslint/js`(代替 `eslint:recommended`)
- `eslint-plugin-vue`
- `eslint-config-prettier`(注意:在 Flat Config 中,我们可能需要以不同的方式使用 Prettier)
- `eslint-plugin-prettier`(用于整合 Prettier 规则)
- 注意:`@rushstack/eslint-patch` 在 Flat Config 中可能不需要,因为 Flat Config 本身支持模块解析。
2. 新的配置格式是一个数组,每个配置对象可以包含以下属性:
- `files`: 匹配的文件模式
- `languageOptions`: 语言选项(包括解析器、解析器选项、ecmaVersion 等)
- `plugins`: 插件
- `rules`: 规则
- `settings`: 共享设置
- `processor`: 处理器
3. 我们需要将原来的 `extends` 拆解为对应的插件和配置。注意,在 Flat Config 中,我们直接引入插件和配置,然后通过 `...` 展开配置。
4. 对于 Vue 的支持,我们需要使用 `eslint-plugin-vue` 并配置解析器为 `vue-eslint-parser`。
5. 对于 Prettier,我们原来使用的是 `@vue/eslint-config-prettier/skip-formatting`,在 Flat Config 中,我们可以使用 `eslint-config-prettier` 的扁平配置,但是需要以数组形式展开。同时,我们还需要配置 `eslint-plugin-prettier` 的规则。
具体转换:
第一步:设置文件匹配模式(可选,默认所有文件)
第二步:配置语言选项(languageOptions):
- 设置解析器:Vue 项目需要 `vue-eslint-parser`,同时为了支持最新的 ECMAScript,我们可以使用 `@babel/eslint-parser` 或者直接使用 `espree`(ESLint 默认解析器)?但是 Vue 单文件组件需要 `vue-eslint-parser`。
- 注意:`vue-eslint-parser` 允许我们在 `parserOptions.parser` 中指定脚本的解析器(对于 `<script>` 标签内的代码)。
- 设置 `ecmaVersion: 'latest'` 和 `sourceType: 'module'`。
第三步:引入插件:
- 需要引入的插件:`vue`(即 `eslint-plugin-vue`)和 `prettier`(即 `eslint-plugin-prettier`)。
第四步:规则配置:
- 将原来的 `rules` 对象转换为新的规则配置,注意规则名需要加上插件名前缀(如 `vue/multi-word-component-names` 已经是正确形式)。
- 对于 Prettier 规则,我们原来是在 `prettier/prettier` 规则下配置的选项,现在同样如此。
第五步:处理继承的规则集:
- `eslint:recommended` 在 Flat Config 中可以通过 `...js.configs.recommended` 来引入(需要先导入 `js` 来自 `@eslint/js`)。
- `plugin:vue/vue3-essential` 可以通过 `...vue.configs['vue3-essential']` 引入(需要先导入 `vue` 插件)。
- `@vue/eslint-config-prettier/skip-formatting` 在 Flat Config 中,我们可以使用 `eslint-config-prettier` 提供的扁平配置数组,然后注意跳过格式化的规则。
但是,注意:`@vue/eslint-config-prettier` 是针对 Vue 项目的 Prettier 配置,它可能包含一些 Vue 特定的规则关闭。我们可以直接使用 `eslint-config-prettier` 的配置,然后手动关闭 Vue 中与 Prettier 冲突的格式化规则。
由于 Flat Config 是数组,我们可以将 Prettier 的配置放在最后,以覆盖之前的规则。
具体配置步骤:
1. 安装依赖:
```
npm install -D eslint @eslint/js eslint-plugin-vue eslint-plugin-prettier eslint-config-prettier @babel/eslint-parser vue-eslint-parser
```
2. 创建 `eslint.config.js` 文件(注意:ESLint v9 默认会查找这个文件)
3. 编写配置:
注意:由于新的配置格式是 ESM,所以使用 `import` 和 `export default`。
参考配置代码:
```javascript
// eslint.config.js
import js from '@eslint/js';
import vue from 'eslint-plugin-vue';
import prettier from 'eslint-plugin-prettier';
import eslintConfigPrettier from 'eslint-config-prettier';
export default [
// 1. 基本配置:设置根目录和默认文件匹配
{
ignores: ['**/dist/**', '**/node_modules/**'], // 忽略目录
},
// 2. 使用 eslint:recommended
js.configs.recommended,
// 3. 使用 Vue 3 基础规则
...vue.configs['vue3-essential'],
// 4. 添加 Prettier 配置(跳过格式化规则) - 这里我们使用 eslint-config-prettier 的配置
eslintConfigPrettier,
// 5. 自定义规则和配置
{
// 针对 Vue 文件和 JS 文件
files: ['**/*.vue', '**/*.js'],
languageOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
// 使用 vue-eslint-parser 作为解析器
parser: vue.parser,
// 注意:vue-eslint-parser 要求我们为 <script> 标签指定解析器
parserOptions: {
parser: '@babel/eslint-parser', // 使用 babel 解析器解析脚本
},
},
plugins: {
vue,
prettier, // 注册 prettier 插件
},
rules: {
// 配置 Prettier 规则
'prettier/prettier': [
'warn',
{
singleQuote: true,
semi: false,
printWidth: 100,
trailingComma: 'none',
endOfLine: 'auto',
},
],
// Vue 组件命名规则
'vue/multi-word-component-names': [
'warn',
{
ignores: ['index'],
},
],
// 禁用不规则空格检查
'no-irregular-whitespace': 'off',
},
},
];
```
注意:
- 我们使用了 `@babel/eslint-parser` 作为脚本的解析器,需要安装 `@babel/eslint-parser`。
- 在 `parserOptions` 中,我们通过 `parser` 指定了脚本解析器,这是 `vue-eslint-parser` 要求的。
- 我们通过 `...vue.configs['vue3-essential']` 来应用 Vue 3 基础规则,这已经包含了必要的 Vue 解析器设置,但是我们在后面的自定义配置中又设置了 `parser` 和 `parserOptions`,这样会覆盖前面的设置。因此,我们可以将语言选项的配置移到 `vue.configs['vue3-essential']` 后面,确保使用正确的解析器。
但是,由于 Flat Config 是数组,后面的配置会覆盖前面的配置。所以,我们将自定义规则块放在最后,这样我们的解析器设置会覆盖前面的设置,确保正确。
另一种做法是将解析器设置放在最前面,然后让 Vue 的配置继承这些设置。但是,Vue 的配置要求使用 `vue-eslint-parser`,所以我们必须确保解析器是 `vue-eslint-parser`。
调整:将解析器设置放在 Vue 配置之后,这样我们的解析器设置会覆盖 Vue 配置中的解析器设置?实际上,Vue 的配置中已经设置了正确的解析器,我们只需要在自定义配置中不再覆盖解析器即可?但是,我们还需要设置 `parserOptions.parser` 为 `@babel/eslint-parser`(用于解析 `<script>` 标签内的代码)。
因此,我们可以将 Vue 配置和我们的自定义配置合并,将解析器设置放在 Vue 配置中。但是,Vue 配置已经通过 `...vue.configs['vue3-essential']` 设置了解析器,我们只需要在自定义配置中设置 `parserOptions` 即可。
修改后的配置:
```javascript
// eslint.config.js
import js from '@eslint/js';
import vue from 'eslint-plugin-vue';
import prettier from 'eslint-plugin-prettier';
import eslintConfigPrettier from 'eslint-config-prettier';
export default [
// 忽略文件
{
ignores: ['**/dist/**', '**/node_modules/**'],
},
js.configs.recommended,
...vue.configs['vue3-essential'], // 这里已经设置了 parser: 'vue-eslint-parser'
eslintConfigPrettier,
{
files: ['**/*.vue', '**/*.js'],
// 注意:这里不再设置 parser,因为 Vue 配置已经设置了
languageOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
// 在 Vue 配置中,已经设置了 parser: vue.parser(即 vue-eslint-parser),
// 但我们需要设置 parserOptions.parser 来指定脚本解析器
parserOptions: {
parser: '@babel/eslint-parser', // 解析脚本
},
},
plugins: {
vue,
prettier,
},
rules: {
'prettier/prettier': [
'warn',
{
singleQuote: true,
semi: false,
printWidth: 100,
trailingComma: 'none',
endOfLine: 'auto',
},
],
'vue/multi-word-component-names': [
'warn',
{
ignores: ['index'],
},
],
'no-irregular-whitespace': 'off',
},
},
];
```
但是,注意:`@babel/eslint-parser` 需要额外的配置吗?我们这里没有配置,如果项目中有 Babel 配置文件,它会自动读取。如果没有,可能需要指定一些选项。
另外,`eslint-config-prettier` 的配置已经禁用了与 Prettier 冲突的规则,所以我们将它放在规则配置之前(因为后面的规则会覆盖前面的,所以我们要确保 Prettier 的配置在最后覆盖)。
但是,我们又在自定义规则中配置了 `prettier/prettier`,所以这个规则会在最后生效。
最后,注意规则 `no-irregular-whitespace` 被关闭了,这个规则是 ESLint 核心规则,所以直接写规则名即可。
验证:在项目根目录运行 ESLint 检查(确保使用 ESLint v9+):
npx eslint yourfile.vue
如果遇到解析错误,请检查解析器配置是否正确。
注意:由于新的配置格式还在发展中,可能会遇到一些插件兼容性问题。如果遇到问题,请查阅相关插件的文档,看是否支持 Flat Config。
另外,原来的 `@rushstack/eslint-patch/modern-module-resolution` 在 Flat Config 中不再需要,因为 Flat Config 使用原生的模块解析。
以上配置仅供参考,实际项目可能需要根据具体情况进行调整。
相关问题:
1. 如何解决 ESLint 在 Flat Config 中无法识别 Vue 文件的问题?
2. 如何为 TypeScript 项目配置 ESLint Flat Config?
3. 在 Flat Config 中如何配置 Prettier 的覆盖规则?</think>### 将 `.eslintrc.js` 转换为 `eslint.config.js` 格式的完整指南
ESLint 9+ 引入了新的扁平化配置格式(Flat Config),以下是完整的转换规则和映射方法:
#### 核心转换规则
| 旧配置项 | 新格式映射 | 示例 |
|----------|------------|------|
| `module.exports` | `export default []` | `export default [/* 配置数组 */]` |
| `extends` | 直接导入配置对象 | `import js from '@eslint/js'` |
| `parserOptions` | `languageOptions` 对象 | `languageOptions: { ecmaVersion: 'latest' }` |
| `plugins` | 导入后注册在 `plugins` 字段 | `import vuePlugin from 'eslint-plugin-vue'` |
| `rules` | 保持相同结构 | `rules: { 'no-var': 'error' }` |
| `root: true` | 配置 `ignores` 字段 | `ignores: ['**/node_modules/**']` |
#### 转换后的完整配置
```javascript
// eslint.config.js
import js from '@eslint/js';
import vuePlugin from 'eslint-plugin-vue';
import prettierConfig from 'eslint-config-prettier';
export default [
// 基础配置
{
ignores: ['**/node_modules/**'], // 替代 root: true
languageOptions: {
ecmaVersion: 'latest', // 原 parserOptions
sourceType: 'module'
}
},
// ESLint 推荐规则
js.configs.recommended,
// Vue 3 规则
...vuePlugin.configs['vue3-essential'],
// Prettier 集成
prettierConfig,
// 自定义规则
{
rules: {
'prettier/prettier': [
'warn',
{
singleQuote: true,
semi: false,
printWidth: 100,
trailingComma: 'none',
endOfLine: 'auto'
}
],
'vue/multi-word-component-names': [
'warn',
{ ignores: ['index'] }
],
'no-irregular-whitespace': 'off'
}
}
];
```
#### 关键配置说明
1. **模块解析补丁**
不再需要 `@rushstack/eslint-patch`,新格式内置模块解析[^1]
2. **Vue 解析器配置**
通过 `vuePlugin.configs` 自动包含 Vue 解析器,无需单独声明
3. **规则继承机制**
使用扩展配置时直接展开数组:
```javascript
...vuePlugin.configs['vue3-essential'] // 替代 extends
```
4. **文件作用域限定**
可针对特定文件类型配置:
```javascript
{
files: ['**/*.vue'],
rules: { 'vue/require-prop-types': 'error' }
}
```
#### 验证步骤
1. 安装必要依赖:
```bash
npm install -D eslint @eslint/js eslint-plugin-vue eslint-config-prettier
```
2. 运行检查:
```bash
npx eslint yourfile.vue
```
3. 解决常见问题:
- 若遇 `import` 错误,确保使用 `.mjs` 扩展名或在 `package.json` 设置 `"type": "module"`
- Vue 文件解析失败时检查 `eslint-plugin-vue` 版本 (需 v9+)
#### 配置映射示意图
```mermaid
graph LR
A[旧配置 .eslintrc.js] --> B[新配置 eslint.config.js]
B --> C[语言选项 languageOptions]
B --> D[插件导入 plugins]
B --> E[规则继承 扩展展开]
B --> F[文件匹配 files/ignores]
```
### 相关问题
1. 如何解决 Flat Config 中 Vue 单文件组件解析失败的问题?
2. 在 ESLint 新格式中如何集成 TypeScript 类型检查?
3. 新旧配置格式混用时优先级如何确定?
4. 如何为不同文件类型(JS/Vue/TS)设置独立规则?
> 提示:转换后建议删除旧配置文件,避免规则冲突[^2][^3]。
阅读全文