前端git提交规范

149 阅读1分钟

记录(项目要有git和git仓库)

1.执行命令

npx husky-init && npm install

命令执行三件事: 1.会安装husky 2.生成prepare脚本命令 3.生成.husky文件夹

2.在package.json中添加scripts脚本命令

"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",

3.修改.husky文件夹下的pre-commit文件

npm test => npm run lint

#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npm run lint

4.执行git commit之前就会执行 npm run lint

代码提交风格

1.安装

npm install commitizen -D

npx commitizen init cz-conventional-changelog --save-dev --save-exact (约束提交的log)

  • 注意: cz-conventional-changelog这个会生成配置

image.png

2.提交步骤

git add .
npx cz

通过 git reflog 查看提交信息

image.png

一些提交限制的message类型

image.png

3.通过cz进行代码提交时,限制使用git commit提交

3.1 安装

npm i @commitlint/config-conventional @commitlint/cli -D

3.2 新建文件并配置

image.png

commitlint.config.js

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

3.3 执行如下命令,给.husky文件夹生成 commit-msg 文件

npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

image.png

4.简化提交命令

"commit": "cz"

执行 npm run commit = npx cz

image.png

注意: 提交时通过eslint进行错误检测, 报错先解决error