npm 包 @bentley/eslint-plugin 使用教程-JavaScript中文网-JavaScript教程资源分享门户

什么是 @bentley/eslint-plugin？

@bentley/eslint-plugin 是一个针对前端开发中使用的 ESLint 规则集的 npm 包。该包内置了一系列的规则来帮助前端开发者更好地维护代码质量。通过这个 npm 包，我们可以在项目中轻松地使用这些规则，并进行配置。

如何安装 @bentley/eslint-plugin？

通过 npm 安装：

npm install @bentley/eslint-plugin --save-dev

如何使用 @bentley/eslint-plugin？

1. 安装依赖

在项目中使用 @bentley/eslint-plugin 之前，需要先安装相关依赖：

npm install eslint eslint-config-bentley @bentley/eslint-plugin --save-dev

eslint 是 ESLint 的主体插件。
eslint-config-bentley 是针对规则设定的配置插件，可以通过该插件来快速设置规则。
@bentley/eslint-plugin 是实际的规则库。

2. 配置 ESLint

在项目目录下新建 .eslintrc 文件，并添加以下内容：

{
  "extends": ["eslint:recommended", "plugin:@bentley/eslint-plugin/recommended"]
}

在 extends 字段中，我们引入了 eslint:recommended 和 plugin:@bentley/eslint-plugin/recommended，前者是 ESLint 官方提供的一组推荐规则，后者则是我们引入的 @bentley/eslint-plugin 规则。

Tips：如果你需要自定义规则，可以在 .eslintrc.js 中定义，然后在上述的 .eslintrc 文件中引入即可。

3. 运行 ESLint

你可以在 package.json 中添加一个运行指令：

{
  "scripts": {
    "lint": "eslint src/**/*.js",
  }
}

运行 npm run lint 命令即可检查项目代码是否符合规范。如果有错误或警告，将会在控制台中输出。

示例代码

-- -------------------- ---- -------
-- --- ----
----- ---- - --------
  -----------------
    -------------- -- -----------
  -
  -----------------
    -------------- -- -----------
  -
-

-- ---- ----
----- ---- - --------
  ------------------
    -------------- -- -----------
  -
  ------------------
    -------------- -- -----------
  -
-

上述代码中，我们定义了一个函数，将 a 和 b 进行参数校验。这里使用了 @bentley/eslint-plugin 中的规则之一：禁止使用 == 来进行值比较，而应该使用 ===。这样可以有效避免由于类型转换而造成的风险。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/5f73ccdea9b7065299ccbc3b