y-commit
v0.1.0
Published
husky, commitlint, git cz
Downloads
23
Readme
y-commit
|包名| 地址 | 描述 |
|---|---|---|
| yorkie || 增强 git commit(类似 husky) |
| lint-staged |
| 只校验提交的代码 |
| commitizen |
| 可视化的选择 commit 信息 |
| cz-conventional-changelog |
| 生成日志 |
| conventional-changelog-cli |
| 日志 CLI |
| @commitlint/cli |
| commitlint 规范 |
| @commitlint/config-conventional |
| commitlint 配置 |
提交规范合集, 安装了以上所有依赖。
使用 / use
$ yarn cz # 相当于 git add . && git commit -m'feat: commit msg'
以后想要 commit
代码,只需要使用这个命令即可。
$ yarn log # 添加日志
按照版本号自动生成 CHANGELOG.md
到你的工作根目录。
安装 / Install
$ yarn add y-commit --dev
配置 / Config
$ npx y-commit
安装好插件之后,只需要跑一下这个命令,就会增量的,添加以下配置到你的项目 package.json
中。
{
"scripts": {
"cz": "git add . && git cz",
"log": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md"
},
"gitHooks": {
"pre-commit": "lint-staged",
"commit-msg": "commitlint -E GIT_PARAMS"
},
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
}
}
并拷贝 commitlint.config.js
文件到 package.json
文件夹相同目录。