ESLint v9.0.0 新纪元:探索 eslint.config.js 的奥秘 (4)

从 v9.0.0 开始,官方推荐的配置文件格式是 eslint.config.js,并且支持 ESM 模块化风格,可以通过 export default 来导出配置内容。

js 复制代码
// eslint.config.js
export default [
    {
        rules: {
            semi: "error",
            "prefer-const": "error"
        }
    }
];

导出的是一个数组,这样可以支持项目中不同的文件或文件类型定义不同的规则。例如,你的项目中既有 JS 代码也有 TS 代码,你可能想要针对不同的代码类型配置不同的 ESLint 检查规则:

js 复制代码
// eslint.config.js
export default [
  {
    files: ["*.js"],
    rules: {
      "no-var": "error"
    }
  },
  {
    files: ["*.ts"],
    rules: {
      "@typescript-eslint/no-var": "error"
    }
  }
];

如果你在 package.json 中没有指定 type: module,那么你就使用的是 CommonJS 规范,ESLint 配置文件在做模块导出时也需要使用 CommonJS 模块规范:

js 复制代码
// eslint.config.js
module.exports = [
    {
        rules: {
            semi: "error",
            "prefer-const": "error"
        }
    }
];
配置对象选项

具体的配置选项如下:

  • files - 一个含有 glob 模式的数组,指示应用配置对象的文件。如果未指定,配置对象应用于所有由任何其他配置对象匹配的文件。
  • ignores - 一个含有 glob 模式的数组,指示配置对象不应用于的文件。如果未指定,配置对象应用于所有由 files 匹配的文件。
  • languageOptions - 一个包含与 JavaScript 的 lint 设置有关的设置对象。
    • ecmaVersion - 支持的 ECMAScript 版本。可能是任何年份(例如,2022)或版本(例如,5)。设置为 "latest" 表示最近支持的版本。(默认:"latest")
    • sourceType - JavaScript 源码的类型。可能的值为 "script" 表示传统脚本文件,"module" 表示 ECMAScript 模块(ESM),以及 "commonjs" 表示 CommonJS 文件。(默认情况下 "module" 对应 .js 和 .mjs 文件,"commonjs" 对应 .cjs 文件)
    • globals - 一个对象,指定在 linting 过程中应添加到全局作用域的额外对象。
    • parser - 包含 parse() 方法或 parseForESLint() 方法的对象。(默认值为 espree)
    • parserOptions - 一个对象,指定直接传递给 parser 上的 parse() 或 parseForESLint() 方法的额外选项。可用的选项依赖于解析器。
  • linterOptions - 包含与 linting 相关配置的对象。
    • noInlineConfig - 布尔值,指示是否允许内联配置。
    • reportUnusedDisableDirectives - 布尔值,控制是否报告未使用的 eslint-disable 指令。
  • processor - 包含 preprocess() 和 postprocess() 方法的对象,或者指示插件内部处理器名称的字符串(例如,"pluginName/processorName")。
  • plugins - 包含插件名称到插件对象的名称-值映射的对象。当指定了 files 时,这些插件仅对匹配的文件可用。
  • rules - 包含具体配置规则的对象。当指定了 filesignores 时,这些规则配置仅对匹配的文件可用。
  • settings - 一个包含键值对信息的对象,这些信息应对所有规则都可用。
具体配置项示例
globals

该配置项位于 languageOptions 配置项下面,用于配置一些全局的设定:

js 复制代码
// eslint.config.js
export default [
    {
        files: ["**/*.js"],
        languageOptions: {
            globals: {
                var1: "writable",
                var2: "readonly"
            }
        }
    }
];

在上面的配置中,我们指定了 var1 这个变量是可写的,但 var2 这个变量是只读的。假设你有如下的代码:

js 复制代码
var1 = 100;
var2 = 200; // 报错
parsers

配置解析器。解析器的作用是负责将源码解析为抽象语法树。ESLint 默认使用的解析器为 Espree,但是你可以指定其他的解析器,解析器需要是一个对象,该对象里面包含了 parse 或者 parseForESLint 方法。

js 复制代码
// eslint.config.js
import babelParser from "@babel/eslint-parser";

export default [
    {
        files: ["**/*.js", "**/*.mjs"],
        languageOptions: {
            parser: babelParser
        }
    }
];

在上面的配置中,我们就指定了使用 Babel 解析器来解析源码。

processor

这个是处理器,主要用于处理 ESLint 默认不能够处理的文件类型。举个例子,假设有一个 Markdown 类型的文件,里面有一些 JS 代码,默认这些 JS 代码是不能够被 ESLint 处理的,通过添加额外的处理器,可以让 ESLint 能够对这些格式的文件进行 lint 检查。

js 复制代码
// eslint.config.js
import markdown from "eslint-plugin-markdown";

export default [
    {
        files: ["**/*.md"],
        plugins: {
            markdown
        },
        processor: "markdown/markdown",
        settings: {
            sharedData: "Hello"
        }
    }
];

通过上述配置,我们可以让 ESLint 能够处理 Markdown 文件中的 JavaScript 代码,并对其进行 lint 检查。

以上就是关于 ESLint 配置文件的一些关键点。随着 ESLint 不断发展,新的配置选项和功能也会不断加入,因此建议定期查看官方文档以获取最新信息。

相关推荐
洲星河ZXH几秒前
Java,集合框架体系
开发语言·windows
宠..6 分钟前
写一个感染型病毒
开发语言·安全·安全性测试
wheelmouse77886 分钟前
一个优雅、通用、零侵入的 CSV 导出工具类(Java 实战)
java·开发语言
阿蒙Amon25 分钟前
JavaScript学习笔记:6.表达式和运算符
javascript·笔记·学习
cike_y36 分钟前
JavaWeb-Request应用与Cookie&[特殊字符]️Session
java·开发语言·安全·java安全
胡萝卜3.01 小时前
深入C++可调用对象:从function包装到bind参数适配的技术实现
开发语言·c++·人工智能·机器学习·bind·function·包装器
小a杰.1 小时前
Flutter 设计系统构建指南
开发语言·javascript·ecmascript
BD_Marathon1 小时前
【JavaWeb】Servlet_url-pattern的一些特殊写法问题
java·开发语言·servlet
中文很快乐1 小时前
java开发--开发工具全面介绍--新手养成记
java·开发语言·java开发·开发工具介绍·idea开发工具