Skip to content
This repository has been archived by the owner on Dec 27, 2022. It is now read-only.

mai-space/plugin-phpstorm-commit-template

Repository files navigation

Version Downloads

Git commit template Plugin for IntelliJ

Forked from: [MobileTribe/commit-template-idea-plugin]. I used parts of his code, but heavily modified it and am planning on changing more.

Find downloadable Plugin: here

This plugin allows to create a commit message with the following template:

[<FLAGS>][<TYPE>] <SUBJECT>

Breaking Changes: (optional) 
<BREAKING CHANGES HERE>    
    
Tasks: (optional) 
<TASK LIST HERE&>

To-Do's: (optional) 
<TO-DOs HERE>

refs: #<TICKET NUMBER HERE>

From the commit guidelines of TYPO3 here.

Installation

Open your preferences.
preferences

Go to plugins in your preferences and select in the upper right "Install Plugin from Disk".
install_plugin

Go to your downloaded JAR File and select it in the file-browser.
select_plugin

Click apply/ok.
apply

Usage

Open your Commit-Dialog by clicking the module or pressing Control/CMD + K.
You can open the template dialog by pressing Control + Shift + K.
open_dialog

Once you are in the dialog, you can navigate by using the Tab Key.
Fill the form as you see fit.
dialog

If you are happy with your commit message, press Apply and the message will be templated and inserted into your commit message dialog
filled_dialog

Please note, that the template is dynamic. So filling breaking changes will result in the [!!!] flag being set.
This also works with the to-do list which results in the [WIP] flag being set.
If you do not want any flags, just fill the Done Tasks Section, so only the Type will be displayed.
inserted_dialog

Open Tasks:

  • Reorder the lists in Commit Message
  • Fix Keyboard Shortcut
  • Automatically commit and push selected changes
  • Enhance UX by fixing Design and use different elements in Swing

Partner

IW Medien Logo