Skip to content

patou/gitmoji-intellij-plugin

Repository files navigation

Gitmoji Plus: Commit Button

Add a gitmoji emoticon in your commits to make them sexier! This plug-in will help you to choose and add the gitmoji, via a button in the Commit window, among a predefined list of emoticons coming from reference commit rules.

Features :

  • Button near the Commit History Message allow to dispay the list of gitmoji
  • Option to use the code (:sparkles:) or the unicode version (✨)
  • Insert or replace the gitmoji before the message (keep the git commit message)
  • Shortcut to open the list : ctrl alt g (or cmd alt g on mac)
  • Load the list of gitmoji on startup from the repos of gitmoji (fallback to a local list if error).
  • Allow to display the gitmoji in a new column in the commit history
  • Translate the gitmoji description in your chinese and french language.

See the gitmoji website for have the list of Emoji and their signification.

Button to add gitmoji List to choose gitmoji Multiple configurations for the plugin Insert gitmoji unicode Display a gitmoji column Translate gitmoji in chinese

Installation

https://plugins.jetbrains.com/plugin/12383-gitmoji/

In IntelliJ, go to preference, then Plugins, and search Gitmoji by Patrice de Saint Steban. After install, and restart, you will have a button on the commit dialog.

Contrib

You can contrib by adding issues, or create pull request.

  • Import the project in IntelliJ.
  • Write your code
  • Use graddle tasks runIde to run and test the plugin

Translation

You can help to translate the emoji description in your language.

  • Copy the file src/main/resources/gitmojis.yaml to src/main/resources/gitmojis-<your_language>.yaml
  • Translate the description in your language
  • Add the language in the src/main/kotlin/com/github/patou/gitmoji/GitmojiLocale.kt class
  • Create a pull request

Publish plugin

First time, copy gradle.properties.sample to gradle.properties

Execute the publishPlugin gradle task

Inspiration plugin

This plugin was inspired from the plugin created by @biezhi : https://github.com/biezhi/gitmoji-plugin. Thanks for his works.