db-commit-cli

db-commit-cli

git commit信息规范及格式检查工具

安装

使用 npm 安装

npm install --save-dev db-commit-cli

使用 yarn 安装

yarn add -D db-commit-cli

查看帮助

npx db-commit-cli -h

安装配置

在终端执行 npx db-commit-cli

会自动添加以下项目:

• commitizen、cz-customizable及相关配置
• commitlint、husky相关依赖及配置
• commitlint规则文件引入

项目内使用

自动添加了cz脚本命令

执行yarn cz或npm run cz会自动暂存文件并触发commitizen提交提示，通过交互完成信息输入即可完成标准化的提交

如果全局安装了commitizen，可以执行git cz来代替git commit，但此时如果没有暂存文件需要自己手动暂存

gitmojis

项目中使用了gitmoji作为提交时的表情，其中一个依赖插件需要使用gitmojis.json，由于网络原因这个文件比较难下载，所以初次安装时已经集成到配置中，后续安装需要手动执行命令安装

所以在重新安装依赖后可能会使该文件丢失，造成提交确认后卡住很长一段时间或者报错，可以执行npx db-commit-cli --add-mojis来安装gitmojis.json文件