前端项目接入git提交信息规范

2019-08-05 本文已影响0人爱死寂寞零

目的

规范化代码提交流程，让changelog看起来更清晰，适合大型项目合作开发，利于项目维护和提交检查

message 规范格式

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

其中只有subject是必需的

type

feat 新功能
fix 修复bug
docs 文档类变动
style 代码格式、规范变动
refactor 重构，不是feat和fix
perf 提升性能
test 增加测试
build 构建工具变动
cli 命令配置变动
chore 其他
revert 撤销commit

scope

变动范围

subject

简短且必要的描述

body

详细描述

footer

footer用于两种情况
1、不兼容变动breaking changes，说明理由、迁移步骤
2、关闭issue，填入issue id

工具

本次用到的第三方库有commitizen、commitlint和standard-version

commitizen

该工具提供交互式命令逐步完成提交操作

npm install commitzen --save-dev

为了实现交互式，需要安装他们提供的适配器

commitizen init cz-conventional-changelog --save-dev --save-exact

完成后，会在package.json中自动生成以下代码：

"config": {
  "commitizen": {
    "path": "./node_modules/cz-conventional-changelog"
  }
}

这样，就可以用git cz代替git commit了，但是git commit依旧可以提交且没有交互式体验，为了使git commit的效果跟git cz一样，这里可以利用git hooks来达到目的，引入一个小工具husky。

npm install husky --save-dev

然后在package.json中加入：

"husky": {
  "hooks": {
    "prepare-commit-msg": "exec < /dev/tty && git cz --hook",
  }
}

提示：exec < /dev/tty为了让git hooks变成交互式
这样git commit也能实现这种效果了

commitlint

该工具可以检测message是否符合规范

npm install --save-dev @commitlint/{cli,config-conventional}

生成配置文件

echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js

然后在package.json中修改husky配置：

"husky": {
  "hooks": {
    "prepare-commit-msg": "exec < /dev/tty && git cz --hook",
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}

这样如果检测到不符合规范格式时都会报错误提示

关于CHANGELOG.md

commit message可以输出到CHANGELOG.md，但这里没有考虑每次提交自动生成CHANGELOG.md，原因如下：

变动频繁，可能此文件会造成冲突
提交信息针对一次提交，提交时又会变动CHANGELOG.md造成二次提交，没找到一起提交的方式

据于此，考虑每次发版时进行CHANGELOG.md的变动

standard-version

该工具可以实现生成CHANGELOG.md一次提交、版本管理、打tag

npm i --save-dev standard-version

因为我们的项目每次发版是升中间版本号及都是master分支进行的，在package.json的scripts中加入以下命令：

"release": "standard-version -r minor && git push origin master --follow-tags"

以后每次发版时需要运行下就好了，hotfix需要去掉参数minor

有个小问题就是standard-version也有commit过程，commit message时跟前面的交互式有冲突，交互式提示显示不出来