git push被拒绝_规范git项目提交并自动生成项目commit log

commit message 是开发的日常操作, 好的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG, 对项目的管理实际至关重要, 但是在平时工作时，只依赖大致的开发规范和自觉，很难形成一种普遍约束。而通过本文，对项目进行一些基础配置，让开发者在提交时可以自动对提交作出规范

1，项目效果

代码提交

2，自动生成commit 日志

2，配置

依赖包

npm i vue-cli-plugin-commitlint commitizen commitlint conventional-changelog-cli husky -D

配置package.json

{"scripts": {"log": "conventional-changelog --config ./node_modules/vue-cli-plugin-commitlint/lib/log -i CHANGELOG.md -s -r 0","cz": "npm run log && git add . && git cz"},"husky": {"hooks": {"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"}},"config": {"commitizen": {"path": "./node_modules/vue-cli-plugin-commitlint/lib/cz"}}
}

配置文件commitlint.config.js

module.exports = {extends: ['./node_modules/vue-cli-plugin-commitlint/lib/lint']
};

使用：

npm run cz  # git add . && git commit -m 'feat:(xxx): xxx'
npm run log # 生成 CHANGELOG

官方文档：

vue-cli-plugin-commitlintwww.npmjs.com

3，各个包的作用解释

根据上面的配置，已经可以给项目配置提交的规范了。如果只是想应用，那么后面的各个包的功能解释部分可以选看。

husky
commitizen
commitlint
conventional-changelog-cli

husky: git命令时，自定义指定一些动作

// package.json
{"husky": {"hooks": {"pre-commit": "npm test","pre-push": "npm test","...": "..."}}
}
// commit之前会走 test
// push之前会走 test

commitlint

可以帮助我们 lint commit messages, 如果我们提交的不符合指向的规范, 直接拒绝提交, 比较狠.

commitizen

我们需要借助它提供的 git cz 命令替代我们的 git commit 命令, 帮助我们生成符合规范的 commit message

conventional-changelog-cli

根据git的metadata生成changelog

所以，回看一下刚才的package.json

{"scripts": {"log": "conventional-changelog --config ./node_modules/vue-cli-plugin-commitlint/lib/log -i CHANGELOG.md -s -r 0","cz": "npm run log && git add . && git cz"},"husky": {"hooks": {"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"}},"config": {"commitizen": {"path": "./node_modules/vue-cli-plugin-commitlint/lib/cz"}}
}

当输入yarn cz时，

0, 首先生成log

1，走命令git cz。生成commit message

2，husky检查commit-msg: commitlint -E HUSKY_GIT_PARAMS

3, 校验完成后，自动提交

git push被拒绝_规范git项目提交并自动生成项目commit log相关推荐

vue 打印出git提交信息_规范git项目提交并自动生成项目commit log
commit message 是开发的日常操作, 好的 log 不仅有助于他人 review, 还可以有效的输出 CHANGELOG, 对项目的管理实际至关重要, 但是在平时工作时,只依赖大致的开发规 ...
“ u”到底是做什么的？ “ git push -u原始主机”与“ git push原始主机”
本文翻译自:What exactly does the "u" do? "git push -u origin master" vs "git pus ...
c 自动生成html文件,webpack4系列教程（三）：自动生成项目中的HTML文件
1. webpack中的CommonJS和ES Mudule 规范 1.1 CommonJs规范 CommonJs规范的出发点:JS没有模块系统.标准库较少.缺乏包管理工具:为了让JS可以在任何地方运 ...
（十五）Alian 的 Spring Cloud 自动生成项目
目录一.创建 1.1.第一步二.mvn命令三.生成项目 3.1.配置 3.1.属性配置 3.2.控制层 3.3.服务层四.验证 4.1.请求生成项目 4.2.生成项目结果 4.3.项目结构一 ...
【在web项目jsp页面自动生成二维码功能】
在web项目jsp页面自动生成二维码功能原文: http://www.cnblogs.com/gczmn/. https://www.jq22.com/jquery-info294/. 先将下面的文 ...
JHipster自动生成项目
JHipster自动生成项目 1. 前提条件 2. 生成过程 3. 最终生成项目推荐学习地址: 推荐教程中文官网地址 1.前提条件需要安装内容: npm.NodeJS.Yeoman.JHipst ...
如何生成像素墨镜，大烟卷？Thug Life风格自动生成项目
文章来源:ATYUN AI平台暴徒生活(Thug Life)是一款非常火热的P图特效,通过加上此特效会让用户的视频或者照片变的非常有趣好玩.其拥有大量贴纸.滤镜效果.视频过渡效果等,使你的视频或照片 ...
IDEA中Maven创建webapp项目时不能自动生成src、webapp目录解决【手动添加】
首先,我标题为什么说必看呢,是因为我因为创建web项目时没有自动生成src目录.webapp目录,也不知道我为什么一定要让去自动生成呢?反正就是去看了很多"大佬"的文章,也尝试了很 ...
.md文件自动生成项目目录结构
自动生成项目目录结构 1)安装mddir (-g是全局安装,可以选择不全局安装,这里因为以后都要使用所以选择的全局安装) npm install mddir -g 2)cd 到你想生成目录的工程结构, ...

git push被拒绝_规范git项目提交并自动生成项目commit log

1，项目效果

2，配置

3，各个包的作用解释

git push被拒绝_规范git项目提交并自动生成项目commit log相关推荐

最新文章

热门文章