【git commit】VSCode中使用Husky & commitlint规范commit messages

最新推荐文章于 2025-04-03 21:21:52 发布

sakoooo

最新推荐文章于 2025-04-03 21:21:52 发布

阅读量3.5k

点赞数

分类专栏： git

本文链接：https://blog.youkuaiyun.com/qq_33539213/article/details/106215608

版权

git 专栏收录该内容

2 篇文章

订阅专栏

用于规范git commit信息，提高团队协作效率。

Conventional Commits（约定式提交规范）

它的 message 格式如下:

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

分别对应 Commit message 的三个部分：Header，Body 和 Footer。

Header

Header 部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。

type: 用于说明 commit 的类型。一般有以下几种:

feat: 新增feature
fix: 修复bug
docs: 仅仅修改了文档，如readme.md
style: 仅仅是对格式进行修改，如逗号、缩进、空格等。不改变代码逻辑。
refactor: 代码重构，没有新增功能或修复bug
perf: 优化相关，如提升性能、用户体验等。
test: 测试用例，包括单元测试、集成测试。
chore: 改变构建流程、或者增加依赖库、工具等。
revert: 版本回滚

scope: 用于说明 commit 影响的范围，比如: views, component, utils, test…
subject: commit 目的的简短描述

Body

对本次 commit 修改内容的具体描述, 可以分为多行。如下图:

# body: 72-character wrapped. This should answer:
# * Why was this change necessary?
# * How does it address the problem?
# * Are there any side effects?
# initial commit

Footer

一些备注, 通常是 BREAKING CHANGE(当前代码与上一个版本不兼容) 或修复的 bug(关闭 Issue) 的链接。

方法一：使用VSCode插件

在插件库搜索Visual Studio Code Commitizen Support 安装，使用快捷键command+shift+P即可按规范提交。

方法二：安装Husky & commitlint

全局安装

npm install --save-dev @commitlint/cli @commitlint/config-conventional

husky继承了Git下所有的钩子，在触发钩子的时候，husky可以阻止不合法的commit,push等等

npm install husky --save-dev

在 package.json 中配置脚本:

"commitlint": {
    "extends": [
      "@commitlint/config-conventional"
    ]
  },

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
 },

完成。
参考：