前端工程化工具系列(五)—— 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 中的格式,如果有错误,则不能提交。

相关推荐
kyriewen20 小时前
编辑弹窗点了取消,列表里的数据怎么还是变了?
前端·javascript·人工智能
Karl_fang20 小时前
🥳 再也不用拿起手机抄验证码!我做了一个 Android → Mac 的「验证码接力」工具
前端·macos·ai编程
谭光志21 小时前
如何让 AI 高效工作
前端·后端·ai编程
FRing031 天前
vue2干货总结11(短信验证、登录功能、统一处理错误(响应拦截器)、将token信息存入vuex、vuex持久化处理)
开发语言·前端·javascript·vue.js·vue2
泯泷1 天前
改一个字,整段都红了?——中文内容差异对比的算法与协议设计
前端·javascript·typescript
再吃一根胡萝卜1 天前
DSH plugin 开发示例:五种插件形态完整代码整理
前端
Yk酱228401 天前
A2UI随笔-demo-01
前端
云起SAAS1 天前
本地生活同城多商户商城系统源码源码 合伙人分红加区域代理加排队返现
前端·javascript·后端
奶油话梅糖1 天前
3 天 1,705 Star:DeepSeek 开源官方聊天前端——零后端纯静态,浏览器直连 API
前端·开源
Linye1 天前
HTML 流程图连线交叉看不清?聊聊画布避障折线与跳弧实现
前端·人工智能