前端限制 git commit 提交格式

团队开发中,每个人 git commit 的习惯都不一样,这样不利于对更新日志的筛选,也可以防止同事跑路后,出现 bug 后,看不懂他当时提交的日志究竟是改了个 bug 还是新增了一个功能,影响开发效率。

这时候就需要用到 git commit 提交规范的工具。为什么一定要用工具规范,定义个提交规范的文档,让大家自行遵守不就好了。这个想法很美好,现实却很骨感,在头脑风暴之后,脑子乏了,可能就会忘记公司规定的提交格式规范,习惯性的用自己之前的提交习惯,造成不必要的麻烦。

使用工具进行规范,如果提交的格式不正确,会给出相应的提示,也无法将 commit 进行提交,需要修改成正确格式的 commit 才能安全的提交到 git 仓库。

配置 commitlint

commitlint 可以检查你的 git commit 日志是否符合你配置的规则,这跟规范 JavaScript 格式的 Eslint 非常像。commitlint 是一个 npm 上的工具,所以需要在 npm init 初始化之后的项目才能使用。

在需要限制 git commit 的项目下安装 commitlint :

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

安装完成后,在项目根目录下,新建一个 .commitlintrc.json 文件,写入如下配置。

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

extends 属性,代表继承某个配置,上边继承了 @commitlint/config-conventional 这个配置文件,把它当成默认配置文件即可。

配置 husky

husky 是一个 git hook 工具,这个工具,可以在 git 执行某些命令之前或者之后再添加一些我们自己的命令,学过 vue 的,可以理解为是 git 的生命周期函数工具。

在当前项目下安装 husky :

npm install husky --save-dev 

激活 hook ,执行完下面的命令后,会在项目根目录下创建出一个名字 .husk 我文件夹,里边是存放 hook 脚本的地方:

npx husky install 

添加一个 hook,就跟 vue 写了个 onMounted 方法类似,执行完后,.husky 文件夹下边会多出一个 commit-msg 的脚本文件:

npx husky add .husky/commit-msg'npx 
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值