vue项目实现git提交前进行commit规范校验

背景:
因团队代码提交不规范,所以需要对git提交的信息经行校验,也可以方便生成change log。

安装

# Install commitlint cli and conventional config
npm install --save-dev @commitlint/{config-conventional,cli}
# For Windows:
npm install --save-dev @commitlint/config-conventional @commitlint/cli

项目根新建配置文件
commitlint.config.js
注意:
使用 commitlint 时报错:commitlint.config.js:1 SyntaxError: Invalid or unexpected token
原来是因为用 echo “module.exports = {extends: [‘@commitlint/config-conventional’]}” > commitlint.config.js 这条命令
生成的 commitlint.config.js 文件不是 utf8 格式的,将文件转成 utf8 格式的就没问题了

# Configure commitlint to use conventional config
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
or 手动添加
module.exports = {extends: ['@commitlint/config-conventional']}

安装husky并激活
(如果在配置eslint commit校验已经安装就不需要)

# Install Husky v6
npm install husky --save-dev
# or
yarn add husky --dev

# Activate hooks
npx husky install
# or
yarn husky install

添加钩子
(也许命令无效)

# Add hook
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'
# Sometimes above command doesn't work in some command interpreters
# You can try other commands below to write npx --no -- commitlint --edit $1
# in the commit-msg file.
npx husky add .husky/commit-msg \"npx --no -- commitlint --edit '$1'\"
# or
npx husky add .husky/commit-msg "npx --no -- commitlint --edit $1"

# or
yarn husky add .husky/commit-msg 'yarn commitlint --edit $1'

需要手动添加

1.添加一个空文件
npx husky add .husky/commit-msg ""   

2.找到.husky/commit-msg
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

undefined 替换=> npx --no -- commitlint --edit $1

到这里就结束了,根据你的需求修改对应的配置即可实现在git提交前对commit规范校验。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值