专业编程教程与实战项目分享平台

网站首页 > 技术文章 正文

前端项目中使用GIT HOOK

ins518 2025-03-10 17:03:41 技术文章 102 ℃ 0 评论

在前端项目中引入 Git Hook 可以帮助你在代码提交或推送前自动执行一些任务,例如代码格式化、 lint 检查、单元测试等。Git Hook 是 Git 提供的钩子机制,允许你在特定的 Git 事件发生时触发自定义脚本。

今天咱们演示在git commit前执行一些任务:

1. 安装依赖

首先,安装必要的工具:

  • Husky:管理 Git Hook。
  • commitlint:校验提交信息是否符合规范。
  • @commitlint/config-conventional:提供常用的提交信息规范(如 feat、fix、add 等)。


2. 初始化 Husky

初始化 Husky,并添加 commit-msg 钩子:


这会在项目根目录下生成 .husky 目录,并创建一个 commit-msg 钩子脚本。

3. 配置 commitlint

在项目根目录下创建 commitlint.config.js 文件,并配置提交信息规则:


4. 测试提交信息

现在,当你提交代码时,提交信息必须符合以下格式:

  • feat: 新增了某某功能
  • fix: 修复了某某bug

如果随便提交信息,不按照@
commitlint/config-conventional
这个规则,会报错


5. 团队共享配置

为了确保团队成员使用相同的 Git Hook 配置,可以将以下内容添加到 package.json 中:


这样,当团队成员运行 npm install 时,Husky 会自动安装并设置 Git Hook。

6. 通过以上步骤,你可以在项目中使用 Git Hook 来规范提交信息:

  1. 使用 Husky 管理 Git Hook。
  2. 使用 commitlint 校验提交信息是否符合规范。
  3. 通过 commitlint.config.js 自定义提交信息规则。

这种方式可以有效提高团队协作的规范性,确保提交信息清晰、一致。

本文暂时没有评论,来添加一个吧(●'◡'●)

欢迎 发表评论:

最近发表
标签列表