简介
eslint-plugin-local-rules 是一个用于扩展 ESLint 规则的 npm 包。它允许你在项目中定义自己的规则，而无需将它们放到全局插件或共享配置中。
安装
在项目根目录下使用以下命令来安装 eslint-plugin-local-rules：
npm install --save-dev eslint-plugin-local-rules
配置
在项目的 .eslintrc 文件中添加如下配置：
{
"plugins": [
"local-rules"
],
"rules": {
"local-rules/my-rule": "error"
}
}其中，local-rules/my-rule 表示一个自定义规则的名称。在代码中使用该规则时，需要在注释中指定该规则的名称：
// eslint-disable-next-line local-rules/my-rule const foo = 'bar';
编写规则
编写规则需要创建一个包含规则实现的 JavaScript 文件，并将其导出至 module.exports 对象。
一个例子如下：
-- -------------------- ---- -------
-------------- - -
----- -
----- ----------
----- -
------------ --------- --- --- -- -------------
--------- ----- -----------
------------ -----
---- -----------------------------------------------
--
------- -- -- -- -------
--
------- ----------------- -
------ -
-------------------- -
-- -
---------------- --- ------------------ --
----------------------- --- --------- --
------------------------- --- -----
- -
----------------
-----
-------- ----------- --- -- -------------
---
-
-
--
-
--在规则实现中，meta 属性定义了规则的元数据，包括类型、描述、类别、推荐程度和文档 URL。create 方法用于创建规则实例，该方法接收一个上下文对象，其中包含对代码树的访问权限。
总结
eslint-plugin-local-rules 可以帮助我们扩展 ESLint 规则，使其更符合项目需求。通过本教程，您可以轻松地编写自己的规则，并将其集成到项目中。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/51627