git提交(commit)规范验证

git-commit-norm

git-commit-norm是在customizable Commitizenplugin的基础上进行的二次开发,进一步提高了自定义的粒度 插件的宗旨是将团队的commit信息格式按照AngularJS team的风格进行规范化,且提供可视化操作界面。 与此同时,插件的最大亮点是可以自由定义各种不同类型的commit的提交规范,能给予团队在AngularJS team风格的基础上充分制定内部commit规范的空间。

下图是操作界面:

Steps

首选需要安装commitizen插件: npm install -g commitizen.

然后再安装: npm install git-commit-norm --save-dev

最后通过配置让 commitizen 使用 git-commit-norm 作为插件。 你需要在package.json中加入如下几行代码:

"config": { "commitizen": { "path": "node_modules/git-commit-norm" } } Configure git-commit-norm 默认将会取寻找配置文件 .cz-config.js 如果不想自己写配置, 可以直接使用 cz-config-example.js 作为你的的配置文件 Options

.cz-config.js:

entry: 入口参数,规定commit的类型并且可通过设置各种属性对不同类型commit的提交格式进行定制化

module.exports = { entry: { fix: { // commit类型 value: 'fix', name: 'fix: 修复Bug', // 标题 scope: { // 副标题 custom: true, // 是否 message: '描述解决了什么问题,如果有Bug号的时候,带上Bug号' }, subject: { // 内容头 prefix: '原因: ', message: '描述引入这个问题的原因' }, body: { // 主内容 prefix: '方案: ', message: '简述解决方案' }, footer: { // 内容位 prefix: '影响范围: ', message: '描述代码影响范围(可选)' } }, messages: { // 定义更项信息 type: '请选择本次commit的类型:', confirmCommit: '您确认要提交以上的commit吗?' } } allowCustomScopes: 允许使用自定义范围

版权声明:

1、该文章(资料)来源于互联网公开信息,我方只是对该内容做点评,所分享的下载地址为原作者公开地址。
2、网站不提供资料下载,如需下载请到原作者页面进行下载。