npm 包 eslint-config-stezu 使用教程

什么是 eslint-config-stezu？

eslint-config-stezu 是一个可复用的 eslint 配置包，由 Stezu 团队维护，其目的是为了帮助前端工程师轻松地遵循 JavaScript 代码的最佳实践和规范。

该包包含了一系列 eslint rule，例如空格、缩进、命名约定、代码风格等等，这些 rule 相当于对代码的 "静态分析"，能够帮助我们更快地发现代码中的潜在问题，提高代码质量。

安装 eslint-config-stezu

1. 在你的项目中安装 eslint 依赖

$ npm install eslint --save-dev

1. 安装 eslint-config-stezu

$ npm install eslint-config-stezu --save-dev

如何使用 eslint-config-stezu

1. 编写 eslint 配置文件 .eslintrc.js

在你的项目根目录中创建一个 .eslintrc.js 文件，用于声明你使用的 eslint 配置。

module.exports = {
  extends: ['eslint-config-stezu'],
  rules: {
    // 加入你的规则覆盖配置
  }
}

1. 编写你的 JavaScript 代码

在你的项目中编写 JavaScript 代码，在保存代码文件的同时，eslint 也会对你的代码做出校验，如果有违反规范的地方，eslint 会给出对应的报错或者警告。

进阶使用

除了使用默认的 eslint-config-stezu 配置文件外，我们还可以根据自己的需求来配置 eslint，比如添加额外的 rule、取消部分 rule 等等。

1. 另起一个 eslintrc.js 文件

我们可以通过另起一个 eslintrc.js 文件，来继承 eslint-config-stezu 并添加其他的规则。

module.exports = {
  extends: ['eslint-config-stezu'],
  rules: {
    // 加入你的规则
  }
}

1. 针对不同的环境定义不同的规则

我们可以通过配置 env 和 globals 属性来根据不同的环境定义不同的规则，比如：Node.js、Browser、ES6 等。

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

示例代码

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

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

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

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

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

结语

现在，你已经学会了如何使用 eslint-config-stezu 来提高你的代码质量。希望本文对你有所帮助。

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