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

相關文章
相關標籤/搜索