本文参加了由公众号@若川视野 发起的每周源码共读活动,点击了解详情一起参与。
今天加入若川大佬发起的源码共读活动,发现了一篇文章提到了一个好用的工具release-it以及一个让commit更规范的git-cz,一起来看看吧。
学会用git-cz让commit规范化
如果你的项目中从来没有打 tag、没有版本的概念,没有生成 changelog,也没有配置 eslint、prettier,没有 commit 等规范。可以试着安装npm i git-cz -D,它可以帮助我们让commit更加规范化,团队开发可维护性更强。
1、先在一个代码仓库里创建一个小项目demo进行测试。
2、开始安装 git-cz (npm i git-cz -D)
然后 在项目根目录的
package.json 中加入如下脚本:
配置好之后,下一次我们的git commit -m"xxx"就可以直接使用 npm run commit啦~
提交时,提示让我们选择一个commit提交的类型(见上图):
| 类型 | 描述 |
|---|---|
| test | 添加确认测试或更正现有的测试 |
| feat | 表示新增了一个功能 |
| fix | 表示修复了一个 bug |
| chore | 其他不修改src或test文件(其他类型的提交) |
| docs | 只涉及到文档的更改 |
| refactor | 代码重构,既不修复错误也不添加功能 |
| style | 代码格式修改 |
| ci | 更改项目持续集成流程 |
| perf | 改进性能的代码更改 |
这里,我选择了test-测试。
下面是一些选项解释:
-
select the type of change that you're committing:(选择一个提交的类型)
-
Write a short, imperative tense description of the change:(写一个简短的变更描述)
-
Provide a longer description of the change: (提供更长的变更描述)
-
List any breaking changes(列出具有破坏性的更改(若有,就用 BREAKING CHANGE 标注提交信息)
-
Issues this commit closes, e.g #123:(提交关闭的问题,例如#123)
使用 release-it 自动提升版本、打 tag、生成 changelog等
1、首先执行(npm init release-it)
2、然后到项目中找到release-it.json文件,在里头增加以下配置:
3、再安装 changelog 插件(npm i @release-it/conventional-changelog -D)
4、走一波 npm run release(记得先commit了再执行,不然会提示文件无变动。)
总结与反思:
1、作为一名前端,却只会日常业务开发流程,使用CV大法进行改造,仍停留在实现业务流程便可阶段,看源码无比费力,越费力就越不想开始,人总是有畏难心理的,毕竟万事开头难,记录下开始学习的第一篇笔记,希望自己做到以后每天抽半个小时学习源码。
2、每次看见技术大佬更新博客或者技术文章,就肃然起敬,觉得自己没有那么厉害,写文章若是没写好反倒误人子弟了,现在想想其实没有必要把自己看得太过重要,每个人都有自己的是非观与辨别能力,写得不对的地方,别人提出来了反倒能够多一些改进,不能因为害怕批评而放弃了前进,接下来我会继续努力学习,一起加油~。