规范git commit的提交记录

📖博客原文 ：xxoo521.com《规范git commit的提交记录（交互式命令行）》

随着项目体积的增长，参与到项目中的同窗愈来愈多，每一个人都有本身的打 git log 的习惯：

• 格式 1: add: 添加...
• 格式 2: [add]: 添加...
• 格式 3: Add 添加...

为了造成统一的规范，达成共识，从而下降协做开发成本，须要对 git commit 记录进行规范。

规范 git commit 记录

规范 git commit 记录，须要作两件事情：

• 经过交互式命令行，自动生成符合指定规范的 commit 记录
• 提交记录后，在 git hooks 中进行 commit 记录格式检查

问：既然已经交互式生成了规范记录，为何须要在 hooks 进行检查？

交互式生成 commit 记录，须要用户调用自定义的 npm scripts，例如npm run commit。但仍是能够直接调用原生 git 命令 git commit 来提交记录。而检查是在正式提交前进行的，所以不符合要求的记录不会生效，须要从新 commit。

调研：交互式 commit log 规范方案

前期调研结果，关于 commit 提示有两种作法：

1. 直接使用 commitizen 中经常使用的 adapter
2. 根据团队的须要，自定义 adapter

方法 1 的优缺点：

优势 1: 直接安装对应的 adapter 便可

优势 2: 无开发成本

缺点 1: 没法定制，不必定知足团队须要

方法 2 的优缺点：

优势 1: 可定制，知足开发需求

优势 2: 单独成库，发布 tnpm，做为技术建设

缺点 1: 须要单独一个仓库（但开发成本不高）

代码实现

在实际工做中，发现方法 1 中的经常使用规范，足够覆盖团队平常开发场景。因此，选择了方法 1.

step1: 安装 npm 包

npm i --save-dev commitizen cz-conventional-changelog @commitlint/cli @commitlint/config-conventional husky
复制代码

添加 package.json 的配置：

"scripts": {
    "commit": "git-cz"
},
"husky": {
    "hooks": {
        "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
},
"config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
}
复制代码

在项目根目录下建立commitlint.config.js：

module.exports = {
    extends: ["@commitlint/config-conventional"]
};
复制代码

使用方法：再也不使用git commit -m ...，而是调用npm run commit。

👇扫码关注「心谭博客」，查看「前端图谱」&「算法题解」，坚持分享，共同成长👇