lint-staged：让你的代码提交更优雅
May 10·2 min
AI 生成的摘要
本文介绍了在项目中引入 lint-staged 的好处及其配置方法。lint-staged 是一个在 git 暂存文件上运行代码检查工具的工具，能配合 ESLint、Prettier 等使用，确保代码提交符合规范。引入后解决了代码风格不统一、审查时间浪费和低级错误等问题。配置简单，通过安装 lint-staged 和配置 pre-commit 钩子即可。还提供了使用小贴士和参考资源。
最近在项目中引入了 lint-staged，可以让团队的代码提交流程变得更加标准，也大大提高了团队的代码质量。
lint-staged 是什么？
简单来说，lint-staged 就是一个在 git 暂存（staged）文件上运行代码检查工具的神器。它可以配合 ESLint、Prettier 等工具使用，确保每次提交的代码都符合团队的规范。
为什么要用 lint-staged？
说实话，在没用 lint-staged 之前，我们团队经常会遇到这些问题：
- 代码风格不统一，看着难受。
- 代码审查时总是在纠结一些格式问题，浪费时间。
- 偶尔会有一些低级错误混进主分支，导致构建失败。
引入 lint-staged 后，这些问题基本都解决了。它帮我们：
- 统一了代码风格，看着舒服多了。
- 提升了代码质量，减少了一些低级错误。
- 节省了代码审查的时间，我们可以更专注于逻辑问题。
如何配置 lint-staged？
配置 lint-staged 其实挺简单的，我们团队是这么做的：
- 首先，安装 lint-staged：
npm install --save-dev lint-staged
- 配置 pre-commit 钩子: 使用 Husky 或其他 git 钩子工具。
- 接下来是配置 lint-staged。我们在 package.json 中添加了这样的配置：
package.json
"lint-staged": {
"*.{js,ts,tsx}": [
"eslint --cache --fix",
"prettier --write",
"git add"
]
},
使用小贴士
使用 lint-staged 的过程中，我发现了几个小技巧：
- 一定要确保代码通过所有检查后再执行 git add。这样可以避免一些奇怪的问题。
- 如果你的项目比较大，可以考虑只对改动的文件进行检查，这样可以节省不少时间。
- 偶尔会遇到一些特殊情况需要跳过检查，可以使用 git commit --no-verify。不过要小心使用，最好不用。