位置: IT常识 - 正文

git提交规范，规范自己的提交标准(git代码提交规范)

编辑：rootadmin

git提交规范，规范自己的提交标准

推荐整理分享git提交规范，规范自己的提交标准(git代码提交规范)，希望有所帮助，仅作参考，欢迎阅读内容。

文章相关热门搜索词:git提交信息规范化,git提交fix,git提交10054,git commit 规范,git提交10054,git 规范,git提交过程,git提交过程,内容如对您有帮助，希望把文章链接给更多的朋友！

为了规范我的git提交内容，提交的时候commit -m “备注的信息”，但是每个人的备注信息千奇百怪，为了统一，我们进行了git的规范。首先要全局安装commitizen

npm i -g commitizen@4.2.4

然后安装插件

npm i cz-customizable@6.3.0 --save-dev

在package.json中添加代码

"config": { "commitizen": { "path": "node_modules/cz-customizable" } },

最后在根目录中添加一个文件 .cz-config.js 这里就可以做一个规范git提交的规则了

module.exports = { // 可选类型 types: [ { value: 'feat', name: 'feat: 新功能' }, { value: 'fix', name: 'fix: 修复' }, { value: 'docs', name: 'docs: 文档变更' }, { value: 'style', name: 'style: 代码格式(不影响代码运行的变动)' }, { value: 'refactor', name: 'refactor: 重构(既不是增加feature，也不是修复bug)' }, { value: 'perf', name: 'perf: 性能优化' }, { value: 'test', name: 'test: 增加测试' }, { value: 'chore', name: 'chore: 构建过程或辅助工具的变动' }, { value: 'revert', name: 'revert: 回退' }, { value: 'build', name: 'build: 打包' } ], // 消息步骤 messages: { type: '请选择提交类型:', customScope: '请输入修改范围(可选):', subject: '请简要描述提交(必填):', body: '请输入详细描述(可选):', footer: '请输入要关闭的issue(可选):', confirmCommit: '确认使用以上信息提交？(y/n/e/h)' }, // 跳过问题 skipQuestions: ['body', 'footer'], // subject文字长度默认是72 subjectLimit: 72}

在我们修改代码之后，使用git cz 代替git commit -m，然后就能描述自己的git提交的内容了

最后得到一个规范的git提示最后直接提交git push origin master 就能看到git上的规范提交提示了

但是我们还有一个问题，如果我们的程序员忘了git cz 的提交规范该如何解决呢？

下面我们来介绍一下git Hooks

按下面的方式进行安装或者创建需要的插件和文件

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

创建commitlint.config.js文件

module.exports = { // 继承的规则 extends: ['@commitlint/config-conventional'], // 定义规则类型 rules: { // type 类型定义，表示 git 提交的 type 必须在以下类型范围内 'type-enum': [ 2, 'always', [ 'feat', // 新功能 feature 'fix', // 修复 bug 'docs', // 文档注释 'style', // 代码格式(不影响代码运行的变动) 'refactor', // 重构(既不增加新功能，也不是修复bug) 'perf', // 性能优化 'test', // 增加测试 'chore', // 构建过程或辅助工具的变动 'revert', // 回退 'build' // 打包 ] ], // subject 大小写不做校验 'subject-case': [0] }} git提交规范，规范自己的提交标准(git代码提交规范)

后面就是安装husky的插件，他可以检测commitlint的一个工具 ![在这里插入图片描述](https://www.yuucn.com/wp-content/uploads/2023/05/1683031616-66b8e04dcd7f037.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA6K-l6LWw55qE5byv6Lev77yM5LiA5q2l6YO95LiN5Lya5bCR44CC,size_12,color_FFFFFF,t_70,g_se,x_16

1、安装husky

npm i husky@7.0.1 --save-dev

2、启动hooks

npx husky install

3、在package.json中加入一行代码，然后运行

npm set-script prepare "husky install"

4、

npm run prepare

5、 6、

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

npx husky add .husky/pre-commit "npx eslint --ext .js,.vue src"

把package.json的lint-staged代码改成下面