前端工程化工具系列(五)—— Husky(v9.0.11)&lint-staged(v15.2.5):代码提交前的自动审查利器

Husky 允许开发者在Git钩子(hooks)上运行脚本,如pre-commit、pre-push等。 这样就可以在代码提交或推送时自动运行ESLint、Prettier等代码质量工具,来检查提交信息、代码并运行测试。
lint-staged 可以针对暂存的 git 文件进行分析,将它与 Husky 和 ESLint 等工具结合使用,可以提高linting效率

1. 环境要求

v9 以上的 husky,支持 Node.js v18+。

v15 以上的 lint-staged,支持 Node.js v18.12.0+。

在命令行中输入以下内容来查看当前系统中 node 的版本。

bash 复制代码
node -v

Node.js 推荐使用 v18.20.3+ 或者 v20.13.1+。

这里使用的包管理器是 PNPM,版本为 v9.1.4。

1 安装

在项目的根目录下打开命令行(Powser Shell、Zsh、Bash等),运行:

bash 复制代码
pnpm add -D husky lint-staged

2 配置

在命令行中执行:

bash 复制代码
pnpm exec husky init

NPM 则执行:

bash 复制代码
npx husky init

以上命令会在项目的根目录下创建 .husky 文件夹,并在其中创建预提交脚本(pre-commit),同时更新 package.json 中的脚本。

打开 .husky/pre-commit 文件,删除其中的 "pnpm test" ,替换成:

bash 复制代码
pnpm exec lint-staged

2.1 结合 ESLint 和 stylelint

在 package.json 中添加:

json 复制代码
	"lint-staged": {
    "*.{js,vue,ts}": [
      "pnpm exec eslint --fix"
    ],
    "*.{css,scss}": [
      "pnpm exec stylelint --fix"
    ]
  }

在 git commit 的时候,会自动检查和修复提交文件中的错误。有些不能被自动修复的错误,需要手工修改后才可以提交。

2.2 结合 commitlint

Linux/macOS 系统,可执行:

bash 复制代码
echo "pnpm dlx commitlint --edit $1" > .husky/commit-msg

或在 .husky 目录下新建 commit-msg 文件,里边加入以下内容:

bash 复制代码
pnpm dlx commitlint --edit $1

在 git commit 的时候,会自动检查 commit message 中的格式,如果有错误,则不能提交。

相关推荐
薛定谔的算法12 分钟前
Vue.js 条件渲染与列表渲染详解:原理、用法与最佳实践
前端·vue.js·前端框架
_前端小李_21 分钟前
关于预检请求
前端
复苏季风21 分钟前
Vue3 小白的疑惑:为什么用 const 定义的变量还能改?
前端·javascript·vue.js
Mintopia24 分钟前
在 Next.js 中接入 Google Analytics 与 PostHog —— 一场“数据偷窥”的艺术演出
前端·javascript·next.js
遂心_24 分钟前
React useState:20分钟彻底掌握这个让你"状态满满"的Hook
前端·javascript·react.js
月亮慢慢圆25 分钟前
Web Animation API
前端
Mintopia26 分钟前
AIGC驱动的Web界面设计:技术逻辑与用户体验平衡
前端·javascript·aigc
盏茶作酒2928 分钟前
浅拷贝和深拷贝
前端·javascript
在掘金8011029 分钟前
pm2 程序 windows开机启动管理设置
前端
徐_三岁29 分钟前
深入理解 svh、lvh、dvh—— 移动端视口高度解决方案
前端·css