cgc

Node cli about git commit msg 简易版 规范 可自定义格式

默认格式(可自定义格式)

• template: type: [name] #cardNo content (if no cardNo, then it can be #N/A)
• example: test: [mike] #333 add edge case for login test

type only can be one of these types and their meaning as show follow:

• feat: new feature
• test: add or change some test case
• refactor: refactor of the code and not change the behavior of code itself
• style: format the code style, such as indent of code, not related to code itself
• chore: changes to the build process or code infrastructure
• fix: fix the bug
• docs: documentation related, such add content to documentation or add some comments
• revert: revert the previous commit
• temporary: temporary change something maybe for pipeline
• hotfix: fix the bug for emergency

安装：

 npm install -g cgc

初始化 默认参数

> cgc d 不输入option参数 则默认重置name

// 设置默认名字
> cgc d -n name

// 设置默认格式
// 支持type, scope, name, cardId, body任意组装出需要的格式
> cgc d -f "&type&: [&name&] #&cardId& &body&"
// or: cgc d -f "[&name&] &type&: #&cardId& &body&"
// or: cgc d -f "&type&: &name& - #&cardId& &body&"
// or: cgc d -f "&type&(&scope&): &body&"
// or: ...

使用

使用 cgc 命令 代替 git commit -m ""

> git add xxx
> cgc

github

custom-git-commit-msg-sample