English | 简体中文 | Português Brasileiro | Português Europeu | 日本語 | 한국어
Gitmoji tool for git commit messages in VSCode
- Open Visual Studio Code.
- Press
Ctrl+Shift+Xto open the Extensions tab. - Type
Gitmojito find the extension. - Click the
Installbutton, then theEnablebutton.
outputType- Configure the type of emoji output as needed. Default isemoji.
For emoji type:
For code type:
Sample configuration:
{
"gitmoji.outputType": "emoji"
}Notice: If you use Gitlab, type emoji, if you use GitHub, you can type code or emoji.
addCustomEmoji- Add custom emoji other than Gitmoji.
Sample configuration:
{
"gitmoji.addCustomEmoji": [
{
"emoji": "🧵",
"code": ":thread:",
"description": "Add or update code related to multithreading or concurrency"
},
{
"emoji": "🦺",
"code": ":safety_vest:",
"description": "Add or update code related to validation"
}
]
}onlyUseCustomEmoji- Only use your custom emoji, not the ones in the Gitmoji.
Sample configuration:
{
"gitmoji.onlyUseCustomEmoji": true
}showEmojiCode- Enable searching gitmojis by emoji code (example: ambulance will return hotfix).
Sample configuration:
{
"gitmoji.showEmojiCode": true
}asSuffix- Enable emoji insertion as a suffix of the commit message.
Sample configuration:
{
"gitmoji.asSuffix": true
}We welcome all contributions. You can submit any ideas as Pull requests or as Issues, have a good time!
The project is released under the MIT License, see the LICENCE file for details.