贡献核心规则

ESLint 核心规则是包含在 ESLint 包中的规则。

规则编写文档

有关编写规则的完整参考信息，请参阅自定义规则。自定义规则和核心规则具有相同的 API。核心规则和自定义规则之间的主要区别在于

核心规则包含在eslint包中。
核心规则必须遵守本页面中记录的约定。

文件结构

ESLint 中的每个核心规则都有三个文件，其名称与其标识符相同（例如，no-extra-semi）。

在lib/rules目录中：源文件（例如，no-extra-semi.js）
在tests/lib/rules目录中：测试文件（例如，no-extra-semi.js）
在docs/src/rules目录中：Markdown 文档文件（例如，no-extra-semi.md）

重要：如果您向 ESLint 存储库提交核心规则，则必须遵循下面说明的约定。

以下是规则源文件的基本格式

/**
 * @fileoverview Rule to disallow unnecessary semicolons
 * @author Nicholas C. Zakas
 */

"use strict";

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------

/** @type {import('../shared/types').Rule} */
module.exports = {
    meta: {
        type: "suggestion",

        docs: {
            description: "disallow unnecessary semicolons",
            recommended: true,
            url: "https://eslint.org.cn/docs/rules/no-extra-semi"
        },
        fixable: "code",
        schema: [] // no options
    },
    create: function(context) {
        return {
            // callback functions
        };
    }
};
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

规则单元测试

ESLint 核心中的每个捆绑规则都必须有一组与其一起提交的单元测试才能被接受。测试文件的名称与源文件相同，但位于tests/lib/中。例如，如果规则源文件是lib/rules/foo.js，则测试文件应为tests/lib/rules/foo.js。

ESLint 提供了RuleTester实用程序，使编写规则测试变得容易。

性能测试

为了使 lint 过程高效且不显眼，验证新规则或对现有规则的修改对性能的影响非常有用。

要了解如何分析单个规则的性能，请参阅自定义规则文档中的分析规则性能。

在 ESLint 核心存储库中开发时，npm run perf命令提供了启用所有核心规则时 ESLint 运行时间的概览。

$ git checkout main
Switched to branch 'main'

$ npm run perf
CPU Speed is 2200 with multiplier 7500000
Performance Run #1:  1394.689313ms
Performance Run #2:  1423.295351ms
Performance Run #3:  1385.09515ms
Performance Run #4:  1382.406982ms
Performance Run #5:  1409.68566ms
Performance budget ok:  1394.689313ms (limit: 3409.090909090909ms)

$ git checkout my-rule-branch
Switched to branch 'my-rule-branch'

$ npm run perf
CPU Speed is 2200 with multiplier 7500000
Performance Run #1:  1443.736547ms
Performance Run #2:  1419.193291ms
Performance Run #3:  1436.018228ms
Performance Run #4:  1473.605485ms
Performance Run #5:  1457.455283ms
Performance budget ok:  1443.736547ms (limit: 3409.090909090909ms)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

规则命名约定

ESLint 的规则命名约定如下

单词之间使用连字符。
如果您的规则只禁止某些内容，请以no-为前缀，例如no-eval用于禁止eval()，no-debugger用于禁止debugger。
如果您的规则正在强制包含某些内容，请使用没有特殊前缀的短名称。

编辑此页面