当前位置: 首页 > 后端技术 > Node.js

记录为项目添加git提交规范

时间:2023-04-04 00:07:36 Node.js

前言:我们前端团队只有几个人(部署或自动化构建),在提交代码之前,是gitadd.,gitcommit-m,gitpushorigin'姓名'。完成一套后,下飞机离开。直到有一天,测试环境的代码跑不起来了。我查看了构建信息,发现有小伙伴提交了代码,没有合并(我也说很牛逼)。为了防止这样的事情再次发生,我上网了。部分git提交工具文章准备集成到项目中使用commitizen、cz-conventional-changelog、cz-customizable这三个工具。1.首先安装插件yarnaddcommitizen-Dcz-conventional-changelog-Dcz-customizable-D2。配置包(在根目录package.json中添加)"config":{"commitizen":{"path":"node_modules/cz-customizable"}},3.配置规范(使用Angular提交的specs)创建。cz-config.js//.cz-config.jsmodule.exports={types:[{value:"init",name:"?init:projectinitialization",},{value:"feat",name:"?feat:newfeatures",},{value:"fix",name:"?fix:bug修复",},{value:"refactor",name:"?refactor:代码重构(不包括bug修复和新特性)",},{value:"docs",name:"?docs:文档更新",},{value:"test",name:"?test:添加、修改测试用例",},{value:"chore",name:"?chore:对构建过程或辅助工具和库的更改(不影响源文件、测试用例)",},{value:"style",name:"?style:代码格式(不影响影响函数,如空格、分号等格式更正)",},],scopes:[["pages","page-related"],["api","interface-related"],["utils","公共方法相关"],["组件","组件相关"],["hooks","hookrelated"],["ui","uiadjustments"],["styles","stylerelated"],["plugins","pluginsmodification"],["store","store修改"],["deps","项目依赖"],["auth","auth修改"],["README","README修改"],["other","其他修改"],["自定义","以上都不是?我想自定义"],.map(([value,description])=>{return{value,name:`${value.padEnd(30)}(${description})`,};}),消息:{类型:“确保此提交符合规范!\n选择您要提交的类型:",customScope:"请输入自定义范围:",subject:"填写本次提交的描述*(一句话总结):\n",body:'填写更多detailedchangesDescription(不填可以直接回车,需要更多可以用"|"换行):\n',breaking:'列出主要不兼容的变化(可以回车不填直接用"|"改行):\n',breaking:'listn',footer:'ListallchangedISSUESCLOSED例如:#31,#34(如果不填写,可以直接回车,如果要用“|”换行):\n',confirmCommit:'Confirmcommit?(这一步完成后,需要在控制台输入"gitpushorigin<你需要提交的远程分支名称>")',},allowCustomScopes:true,allowBreakingChanges:["feat","fix"],};最后在package.json中添加执行脚本命令“提交”:“git添加。&&git-cz"如果你还想在提交代码前检查代码(vue)"commit":"vue-cli-ser副lint--fix--ext.js,.vue,.ts&&gitadd。&&git-cz》最后直接输入命令:yarncommit看到下图证明成功