前端必备！npm 包 @1stg/lint-staged 使用教程
——让你的代码风格更加规范，代码可读性更高！
在前端开发中，代码质量是非常重要的，而代码风格的规范性和可读性也是保证代码质量的重要方面之一。为了更有效的管理和控制代码风格，我们可以使用 npm 包 @1stg/lint-staged。这篇文章将为大家介绍如何使用 @1stg/lint-staged 这个 npm 包，让你的代码风格更加规范，代码可读性更高！
一、@1stg/lint-staged 简介
@1stg/lint-staged 是一个 npm 包，它可以帮助我们在 Git hooks 中使用 eslint、stylelint、prettier 等工具来校验、格式化代码，以确保代码风格的规范性和可读性。在 commit 代码时，它会自动执行我们指定的校验、格式化操作，并将结果反馈给开发人员。
二、@1stg/lint-staged 安装
首先，你需要使用以下命令在你的项目中安装 @1stg/lint-staged：
npm install @1stg/lint-staged --save-dev
安装完成后，在你的 package.json 中添加以下配置项：
"lint-staged": {
"*.{js,css}": ["eslint --fix", "stylelint --fix", "prettier --write"]
},
"husky": {
"hooks": {
"pre-commit": "lint-staged"
}
}三、@1stg/lint-staged 使用说明
lint-staged 是用于通过 Git 钩子来部分修改暂存区的文件，通常我们使用它来格式化代码，校验语法等操作。上述配置中，我们定义了 *.js 和 *.css 文件需要执行的操作，以及在 pre-commit 钩子触发时执行 lint-staged 这个命令。在使用 lint-staged 时，我们还可以配合其他工具使用，例如 ESLint、StyleLint、Prettier 等。
- ESLint：用于校验、格式化 JS 代码
- StyleLint：用于校验、格式化 CSS 代码
- Prettier：用于代码格式化
例如，我们可以在 *.js 文件上使用 ESLint 来格式化代码，使用 Prettier 来自动格式化代码后再进行 ESLint 的校验。在上述配置项中，eslint --fix 会自动检测并格式化错误的文件，stylelint --fix 会自动格式化 CSS 文件。
四、示例代码
我们来看一个示例代码，以展示如何使用 @1stg/lint-staged。
-- -------------------- ---- -------
-- ------------
-------------- - -
-------- ---------- ------------
-------------- -
------------ --
----------- ---------
------------- -
---- ----
-
--
---- -
-------- -----
----- -----
---- ----
--
------ -
------- --
------------------------------- --- - ----------- ------- ------- ---
------------------------------- --
------------------------------------ --
------------- ------
-
---- -------------------- ---- -------
-- ---------------
-------------- - -
-------- ----------------------------
------ -
--------------------- -----
------------------------------------- -
-----
-
--------------------- ----------
-
--
----------------------------------- ----
-
--其中，.eslintrc.js 和 .stylelintrc.js 分别是 ESLint 和 StyleLint 的配置文件。这里我们使用了 airbnb 作为 ESLint 的扩展以保证代码风格的规范性，同时在 .stylelintrc.js 中定义了部分 CSS 样式的规范性。
五、使用总结
@1stg/lint-staged 这个 npm 包非常实用，对于保证代码质量有很大的帮助。在使用的过程中，我们应该注意以下几点：
- 确保已经安装了必要的校验工具，例如 ESLint、StyleLint 等；
- 根据项目的编码规范编写 eslint、stylelint 规则；
- 遵循 lint-staged 的规则配置，定义需要校验的文件及需要执行的操作；
- 使用 husky 的 pre-commit 钩子来执行 lint-staged，确保在 commit 代码前执行操作。
最后，希望这篇文章可以给大家带来帮助，让大家能够在前端开发中更规范、更高效的管理代码风格，同时也让大家的代码更加可读，更加易维护。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/stg-lint-staged