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

目的

规范化代码提交流程,让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时跟前面的交互式有冲突,交互式提示显示不出来

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,519评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,842评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,544评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,742评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,646评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,027评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,513评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,169评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,324评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,268评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,299评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,996评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,591评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,667评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,911评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,288评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,871评论 2 341

推荐阅读更多精彩内容