Skip to content

pfei-sa/gitmoji-vscode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c4963e2 ยท Feb 14, 2022

History

83 Commits
Dec 13, 2021
Dec 13, 2021
Jan 15, 2022
Jan 15, 2022
Jan 15, 2022
Jan 15, 2022
Dec 13, 2021
Feb 12, 2022
Feb 14, 2022
Feb 14, 2022
Dec 13, 2021
Jun 28, 2020
Jun 28, 2020

Repository files navigation

English | ็ฎ€ไฝ“ไธญๆ–‡

Report Bug ยท Request Feature

Gitmoji tool for git commit messages in VS Code

๐Ÿ’ป 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:

emoji

For code type:

code

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

  • additionalEmojis - Add configurable additionnal emojis.

Sample configuration:

{
  "gitmoji.additionalEmojis": [
    {
      "emoji": "๐Ÿ›",
      "code": ":bug:",
      "description": "Fix a bug.",
      "description_zh_cn": "ไฟฎๅค BUG"
    },
    {
      "emoji": "๐Ÿš‘",
      "code": ":ambulance:",
      "description": "Critical hotfix.",
      "description_zh_cn": "็ดงๆ€ฅ็ƒญไฟฎๅค"
    }
  ]
}

Notice: description_zh_cn is a chinese (zh_CN) version of the description. If empty, the english description will be used.

Only use your additionnal emojis

  • onlyUseAdditionalEmojis - Use your additional emojis instead the ones from the extension.

Sample configuration:

{
  "gitmoji.onlyUseAdditionalEmojis": true
}

Search gitmoji by emoji code

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

Sample configuration:

{
  "gitmoji.showEmojiCode": 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.

About

๐Ÿ˜œ Gitmoji tool for git commit messages in VSCode

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%