自定义处理器

你也可以创建自定义处理器，告诉ESLint如何处理JavaScript以外的文件。

自定义处理器规范

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

module.exports = {
    processors: {
        "processor-name": {
            // 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

preprocess 方法将文件内容和文件名作为参数，并返回一个代码块的数组以进行提示。这些代码块将被单独检查，但仍被注册到文件名上。

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

由插件决定它是否需要只返回一个部分，或多个部分。例如在处理 .html 文件的情况下，你可能想通过合并所有的脚本只返回数组中的一个项目，但对于 .md 文件，每个 JavaScript 块可能是独立的，你可以返回多个项目。

postprocess 方法接收一个二维数组，该数组包括检查器消息和文件名。输入数组中的每一项都对应于从 preprocess 方法返回的部分。postprocess 方法必须调整所有错误的位置，使其与原始的、未处理的代码中的位置相对应，并将其汇总为一个平面数组并返回。

报告的问题有以下位置信息：

{
    line: number,
    column: number,

    endLine?: number,
    endColumn?: number
}
1
2
3
4
5
6
7

默认情况下，ESLint 在使用处理器时不会进行自动修正，即使在命令行上启用了 --fix 标志。为了让 ESLint 在使用你的处理器时自动修正代码，你应该采取以下额外步骤。

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

在最初的问题列表中，fix 属性将指代被处理的 JavaScript 中的修复。postprocess 方法应该将该对象转换为指原始的、未处理的文件中的一个修复。
给处理器添加 supportsAutofix: true 属性。

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

在配置文件中指定处理器

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

例如：

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

参见插件配置文档中的指定处理器获取详情。

文件扩展名处理器

如果一个处理器的名字以 . 开头，ESLint 就会把这个处理器作为文件扩展名处理器来处理，指定自动将这个处理器应用于哪种文件。人们不需要在他们的配置文件中指定文件扩展名的处理器。

比如：

module.exports = {
    processors: {
        // This processor will be applied to `*.md` files automatically.
        // Also, people can use this processor as "plugin-id/.md" explicitly.
        ".md": {
            preprocess(text, filename) { /* ... */ },
            postprocess(messageLists, filename) { /* ... */ }
        }
    }
}
1
2
3
4
5
6
7
8
9
10

module.exports = {
    processors: {
        "processor-name": {
            // 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

编辑此页