Git-commit-plugin For Vscode 一款自动生成规范git提交信息的插件

初衷

在公司因为你们随意提交 git-commit 的信息,致使提交的风格千奇百怪,写的信息不明确,不知道此次提交具体是修复 bug 呢?仍是增长新功能,仍是单纯改了一些配置文件,亦或是重构了一些很差的代码。只能靠你们本身去猜想,就算是本身提交的信息,也可能由于时间长致使本身也不清楚具体此次提交是为了干啥,只能去提交记录里翻代码,久而久之,不利于产品的迭代,以及对于 bug 的定位。前端

为何写这个插件

基于这个缘由,咱们开始寻找比较符合规范的提交格式,Angular 团队的 Angular Team Commit Specification 进入了咱们的视野,格式以下:git

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
复制代码

清晰的信息展示,让咱们以为这个就是咱们正在寻找的!为此咱们开始搜IDE 有没有对应的插件可使用,幸运的是后端 Java 团队使用的 IDEA 直接就有现成的插件可使用,苦逼的咱们前端团队都是统一用的 Vscode ,看到了几款插件,可是都不符合咱们的要求,为了前端团队不拖后腿,因而乎就想着本身写一款符合要求的插件来供团队使用。github

如何使用

  1. 首先咱们须要去 Vscode 插件市场搜索 git-commit-plugin 而且进行安装。

2. 安装完以后可使用组合键 Command + Shift + P 呼出 指令行,并键入指令 show git commit template 或者点击 git 插件栏上的小图标唤醒插件界面。 open.gif 3. 根据本身当前提交所要表达的意义,选择对应的 type 类型去编写 commit 信息 edit.gifjson

结语

写插件的时候也踩了很多坑,官网文档为了找个 API 也是看这看那的,不过最终解决了问题也是值得的。若是以为本项目对你有帮助的,别吝啬你手里的✨给 本项目 点个 star✨,您的鼓励就是对做者最大的支持!发现 bug 或者有啥但愿改进的点,也欢迎在项目底下提 issue 😘。后端

2020年3月30日更新

社区提了不少好的issue,也提了很多 PR ,有修复bug的,也有一些但愿加入的功能的,在此次0.0.4版本的更新里都实现和解决了!markdown

更新内容

✨Feat

  • GitCommitPlugin.ShowEmoji: 支持可配置是否须要 Emoji前缀,默认为true
    GitCommitPlugin.ShowEmoji:true 
    复制代码
  • GitCommitPlugin.CustomCommitType: 支持自定义的Commit Type 前缀,默认为null
    GitCommitPlugin.CustomCommitType:[
      "customTypeName"
    ] 
    复制代码
  • GitCommitPlugin.MaxSubjectWords: 支持修改Subject的最大字数,默认为20
    GitCommitPlugin.MaxSubjectWords:20
    复制代码

🐞Bug Fix

2020年9月22日更新

✨Feat

  • GitCommitPlugin.CustomCommitType: 支持自定义的Commit Type 前缀,默认为null
    GitCommitPlugin.CustomCommitType:[
      "customTypeName"
    ]  or [
     {
         "label": "customTypeName",
         "detail": "customTypeDetail"
     }
    ]
    复制代码

🐞Bug Fix

相关文章
相关标签/搜索