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

相关推荐
Senar3 分钟前
Web端选择本地文件的几种方式
前端·javascript·html
烛阴21 分钟前
UV Coordinates & Uniforms -- OpenGL UV坐标和Uniform变量
前端·webgl
姑苏洛言25 分钟前
扫码小程序实现仓库进销存管理中遇到的问题 setStorageSync 存储大小限制错误解决方案
前端·后端
烛阴35 分钟前
JavaScript 的 8 大“阴间陷阱”,你绝对踩过!99% 程序员崩溃瞬间
前端·javascript·面试
lh_12541 小时前
ECharts 地图开发入门
前端·javascript·echarts
jjw_zyfx1 小时前
成熟的前端vue vite websocket,Django后端实现方案包含主动断开websocket连接的实现
前端·vue.js·websocket
Mikey_n2 小时前
前台调用接口的方式及速率对比
前端
周之鸥2 小时前
使用 Electron 打包可执行文件和资源:完整实战教程
前端·javascript·electron
我爱吃朱肉2 小时前
HTMLCSS模板实现水滴动画效果
前端·css·css3
机器视觉知识推荐、就业指导2 小时前
开源QML控件:进度条滑动控件(含源码下载链接)
前端·qt·开源·qml