自定义处理器 (已弃用)

您还可以创建自定义处理器，告诉 ESLint 如何处理标准 JavaScript 以外的文件。例如，您可以编写一个自定义处理器来从 Markdown 文件中提取和处理 JavaScript（@eslint/markdown 包含为此目的的自定义处理器）。

自定义处理器规范

为了创建一个自定义处理器，从您的模块导出的对象必须符合以下接口

module.exports = {
    processors: {
        "processor-name": {
            meta: {
                name: "eslint-processor-name",
                version: "1.2.3"
            },
            // takes text of the file and filename
            preprocess: function(text, filename) {
                // here, you can strip out any non-JS content
                // and split into multiple strings to lint

                return [ // return an array of code blocks to lint
                    { text: code1, filename: "0.js" },
                    { text: code2, filename: "1.js" },
                ];
            },

            // takes a Message[][] and filename
            postprocess: function(messages, filename) {
                // `messages` argument contains two-dimensional array of Message objects
                // where each top-level array item contains array of lint messages related
                // to the text that was returned in array from preprocess() method

                // you need to return a one-dimensional array of the messages you want to keep
                return [].concat(...messages);
            },

            supportsAutofix: true // (optional, defaults to false)
        }
    }
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

preprocess 方法以文件内容和文件名作为参数，并返回一个要检查的代码块数组。这些代码块将分别被检查，但仍会注册到文件名上。

代码块有两个属性 text 和 filename。text 属性是块的内容，filename 属性是块的名称。块的名称可以是任何内容，但应包含文件扩展名，该扩展名告诉检查器如何处理当前块。检查器检查 --ext CLI 选项以查看是否应检查当前块，并解析 overrides 配置以检查如何处理当前块。

插件需要决定是否需要返回非 JavaScript 文件的一部分或多块内容。例如，在处理 .html 文件的情况下，您可能希望通过组合所有脚本只返回数组中的一个项目。但是，对于 .md 文件，您可以返回多个项目，因为每个 JavaScript 块可能都是独立的。

postprocess 方法接收一个二维数组，其中包含 lint 消息数组和文件名。输入数组中的每个项目都对应于从 preprocess 方法返回的部分。postprocess 方法必须调整所有错误的位置以对应于原始未处理代码中的位置，并将它们聚合到一个单一的扁平数组中并返回它。

报告的问题在每个 lint 消息中具有以下位置信息

type LintMessage = {

  /// The 1-based line number where the message occurs.
  line?: number;

   /// The 1-based column number where the message occurs.
  column?: number;

  /// The 1-based line number of the end location.
  endLine?: number;

  /// The 1-based column number of the end location.
  endColumn?: number;

  /// If `true`, this is a fatal error.
  fatal?: boolean;

  /// Information for an autofix.
  fix: Fix;

  /// The error message.
  message: string;

  /// The ID of the rule which generated the message, or `null` if not applicable.
  ruleId: string | null;

  /// The severity of the message.
  severity: 0 | 1 | 2;

  /// Information for suggestions.
  suggestions?: Suggestion[];
};

type Fix = {
    range: [number, number];
    text: string;
}

type Suggestion = {
    desc?: string;
    messageId?: string;
    fix: Fix;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

默认情况下，即使在命令行上启用了 --fix 标志，ESLint 在使用自定义处理器时也不会执行自动修复。要允许 ESLint 在使用您的处理器时自动修复代码，您应该执行以下额外步骤

更新 postprocess 方法以额外转换报告问题的 fix 属性。所有可自动修复的问题都有一个 fix 属性，它是一个具有以下模式的对象
```
{
    range: [number, number],
    text: string
}
1
2
3
4
```
range 属性包含代码中的两个索引，指的是将被替换的连续文本部分的起始和结束位置。text 属性指的是将替换给定范围的文本。

在初始问题列表中，fix 属性将引用已处理 JavaScript 中的修复。postprocess 方法应转换该对象以引用原始未处理文件中的修复。
在处理器中添加 supportsAutofix: true 属性。

您可以在一个插件中同时拥有规则和自定义处理器。您也可以在一个插件中拥有多个处理器。要支持多个扩展名，请将每个扩展名添加到 processors 元素中，并将它们指向同一个对象。

meta 对象帮助 ESLint 缓存处理器并提供更友好的调试消息。meta.name 属性应与处理器名称匹配，meta.version 属性应与处理器的 npm 包版本匹配。最简单的方法是从您的 package.json 中读取此信息。

在配置文件中指定处理器

要使用处理器，请将其 ID 添加到配置文件中的 processor 部分。处理器 ID 是插件名称和处理器名称的连接字符串，并以斜杠作为分隔符。这也可以添加到配置文件的 overrides 部分，以指定哪些处理器应该处理哪些文件。

例如

plugins:
  - a-plugin
overrides:
  - files: "*.md"
    processor: a-plugin/markdown
1
2
3
4
5

有关更多详细信息，请参阅插件配置文档中的指定处理器。

文件扩展名命名处理器

如果自定义处理器名称以 . 开头，则 ESLint 将该处理器视为文件扩展名命名处理器。ESLint 会自动将处理器应用于具有该文件名扩展名的文件。用户不需要在他们的配置文件中指定文件扩展名命名处理器。

例如

module.exports = {
    processors: {
        // This processor will be applied to `*.md` files automatically.
        // Also, you can use this processor as "plugin-id/.md" explicitly.
        ".md": {
            preprocess(text, filename) { /* ... */ },
            postprocess(messageLists, filename) { /* ... */ }
        }
        // This processor will not be applied to any files automatically.
        // To use this processor, you must explicitly specify it
        // in your configuration as "plugin-id/markdown".
       "markdown": {
            preprocess(text, filename) { /* ... */ },
            postprocess(messageLists, filename) { /* ... */ }
        }
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

您还可以将同一个自定义处理器用于多个文件名扩展名。以下示例显示了对 .md 和 .mdx 文件使用同一个处理器的示例

const myCustomProcessor = { /* processor methods */ };

module.exports = {
    // The same custom processor is applied to both
    // `.md` and `.mdx` files.
    processors: {
        ".md": myCustomProcessor,
        ".mdx": myCustomProcessor
    }
}
1
2
3
4
5
6
7
8
9
10

编辑此页面