README.md

English | 简体中文 | Português Brasileiro | Português Europeu | 日本語 | 한국어

Report Bug · Request Feature

Gitmoji tool for git commit messages in VSCode

💻 Screenshot

📦 Install

1. Open Visual Studio Code.
2. Press Ctrl+Shift+X to open the Extensions tab.
3. Type Gitmoji to find the extension.
4. Click the Install button, then the Enable button.

🔨 Configuration

Select output type

• outputType - Configure the type of emoji output as needed. Default is emoji.

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.

Add configurable additionnal emojis

• 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"
    }
  ]
}

Only use your Custom emojis

• onlyUseCustomEmoji - Only use your custom emoji, not the ones in the Gitmoji.

Sample configuration:

{
  "gitmoji.onlyUseCustomEmoji": true
}

Search Gitmoji by emoji code

• showEmojiCode - Enable searching gitmojis by emoji code (example: ambulance will return hotfix).

Sample configuration:

{
  "gitmoji.showEmojiCode": true
}

Insert emoji at the end of the commit

• asSuffix - Enable emoji insertion as a suffix of the commit message.

Sample configuration:

{
  "gitmoji.asSuffix": true
}

🤝 Contributing

We welcome all contributions. You can submit any ideas as Pull requests or as Issues, have a good time!

📃 License

The project is released under the MIT License, see the LICENCE file for details.