为核心规则贡献力量

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 实用程序，以便轻松地编写规则测试。

性能测试

为了保持 linting 过程的效率和不引人注目，验证新规则或对现有规则的修改的性能影响很有用。

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

在 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。
如果您的规则强制包含某些东西，请使用没有特殊前缀的简短名称。

编辑此页面