统计数据

虽然可以通过设置 TIMING 环境变量来分析 ESLint 运行的整体规则性能，但有时获取更细粒度的计时数据（每个文件每个规则的检查时间）或收集其他感兴趣的指标可能很有用。特别是在开发新的自定义插件以及评估/基准测试新语言或规则集时。对于这些用例，您可以选择性地从 ESLint 收集运行时统计信息。

启用统计数据收集

要启用统计数据收集，您可以选择：

使用 --stats CLI 选项。这会将统计数据传递到用于输出 ESLint 结果的格式化程序中。（注意：并非所有格式化程序都输出统计数据。）
将 stats: true 设置为 ESLint 构造函数的一个选项。

启用统计数据会在每个 LintResult 对象中添加一个新的 stats 键，其中包含诸如解析时间、修复时间、每个规则的检查时间等数据。

因此，它不能通过 stdout 获得，但可以通过使用 CLI 或 Node.js API 的格式化程序轻松摄取，以满足您的特定需求。

◆ 统计数据类型

Stats 值是每次检查运行的计时信息。 LintResult 类型的 stats 属性包含它。它具有以下属性

fixPasses (number)
ESLint 在检查后至少应用一次修复的次数。
times ({ passes: TimePass[] })
花费在（解析、修复、检查）文件上的时间，其中检查指的是每个规则的计时信息。
- TimePass ({ parse: ParseTime, rules?: Record<string, RuleTime>, fix: FixTime, total: number })
  包含花费在（解析、修复、检查）上的时间的对象
  - ParseTime ({ total: number })
    解析文件时花费的总时间。
  - RuleTime ({ total: number })在一个规则上花费的总时间。
  - FixTime ({ total: number })花费在将修复应用于代码的总时间。

CLI 用法

让我们考虑以下示例

/*eslint no-regex-spaces: "error", wrap-regex: "error"*/

function a() {
    return / foo/.test("bar");
}
1
2
3
4
5

使用 --stats 运行 ESLint 并通过内置的 json 格式化程序输出到 JSON

npm

npx eslint file-to-fix.js --fix --stats -f json 
1

yarn

yarn dlx eslint file-to-fix.js --fix --stats -f json 
1

pnpm

pnpm dlx eslint file-to-fix.js --fix --stats -f json 
1

bun

bunx eslint file-to-fix.js --fix --stats -f json 
1

这会生成以下 stats 条目，作为格式化的检查结果对象的一部分

{
    "times": {
        "passes": [
            {
                "parse": {
                    "total": 3.975959
                },
                "rules": {
                    "no-regex-spaces": {
                        "total": 0.160792
                    },
                    "wrap-regex": {
                        "total": 0.422626
                    }
                },
                "fix": {
                    "total": 0.080208
                },
                "total": 12.765959
            },
            {
                "parse": {
                    "total": 0.623542
                },
                "rules": {
                    "no-regex-spaces": {
                        "total": 0.043084
                    },
                    "wrap-regex": {
                        "total": 0.007959
                    }
                },
                "fix": {
                    "total": 0
                },
                "total": 1.148875
            }
        ]
    },
    "fixPasses": 1
}
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

请注意，对于上面的简单示例，所有规则时间的总和应与 TIMING 输出的第一列直接比较。使用 TIMING=all 运行相同的命令，您可以验证这一点

$ TIMING=all npx eslint file-to-fix.js --fix --stats -f json
...
Rule            | Time (ms) | Relative
:---------------|----------:|--------:
wrap-regex      |     0.431 |    67.9%
no-regex-spaces |     0.204 |    32.1%
1
2
3
4
5
6

API 用法

您可以使用 Node.js API 通过将 stats: true 作为 ESLint 构造函数的选项来实现相同的操作。例如

const { ESLint } = require("eslint");

(async function main() {
    // 1. Create an instance.
    const eslint = new ESLint({ stats: true, fix: true });

    // 2. Lint files.
    const results = await eslint.lintFiles(["file-to-fix.js"]);

    // 3. Format the results.
    const formatter = await eslint.loadFormatter("json");
    const resultText = formatter.format(results);

    // 4. Output it.
    console.log(resultText);
})().catch((error) => {
    process.exitCode = 1;
    console.error(error);
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

编辑此页