Repository files navigation

Stop wasting time looking up git commit message emojis. This extension helps you find the right emoji and helps compose your commit message, all without leaving VS Code. You can even supply your own custom emoji mapping to suit the needs of you and/or your team.

• Gitmoji Commit
  • Content
  • Usage
    • Create Commit Message
    • Cheat Sheet
    • Tips
    • Breaking Changes
  • Configuration
    • Emoji Syntax
    • Auto Commit
    • Auto Close
    • Multiline Commit
    • Custom Emoji
    • Custom Emoji Map
  • Future Plans
  • Changelog
  • Demo
  • Other Info
  • Contributors

Currently,Gitmoji Commit adds two commands to VS Code.

Automates creating a commit message by prompting user for the type of commit and commit message text. The type of commit selected determines the emoji. The emoji is inserted into the commit message as either unicode (e.g.✨) or as GitHub emoji markdown colon syntax (e.g.:sparkles:).

When the time comes to type your commit message:

1. Ctl + Shift + P (orCmd + Shift + P on Mac) to open command prompt
2. LocateGitmoji Commit: Create Commit Message command and select
3. Begin typing to filter commit types
4. Select desired commit type viaClick orEnter
5. Type the text of your commit message into the input
6. PressEnter
7. Your commit message will appear in the integrated terminal (commit format -git commit -m ":<your emoji>: <your message>")
8. Proceed with life

• intended for use with integrated terminal

Reference all Gitmojis including their emoji, colon syntax, and description.

1. Ctl + Shift + P (orCmd + Shift + P on Mac) to open command prompt
2. LocateGitmoji Commit: Open Cheat Sheet command and select
3. Optionally, click an emoji or colon syntax to copy
4. For reference purposes

Simplify usage of either command by mapping each one to a custom keyboard shortcut. For more information on keyboard shortcuts refer to theVS Code Documenation.

Version2.0.0 changed a few items. Depending on your settings this may or may not impact your use of the extension. These changes were made to use better semantic naming for commands and options.

1. Commands are nowextension.gitmojiCommit andextension.gitmojiCheatSheet. If you had keyboard shortcuts to the previousextension.emojiCommit orextension.emojiCheatSheet you need to update those.

2. The option for emoji syntax is nowgitmoji.emojiSyntax. If you had this setting set tounicode you have to set this option again. If you usecolon syntax there is no need to change as that is the default.

Emoji Syntax determines the format of the emoji inserted into the commit message. The defaultcolon syntax uses GitHub's emoji markdown to represent the emoji. A full list of emojis supported by GitHub can be foundhere. Changing this setting tounicode will insert the actual emoji into the commit message.

Auto Commit determines the behavior of how the composed commit message is delivered to the integrated terminal. By default this setting isfalse. The commit message will be inserted into the terminal but will require the user to press enter to execute the command. If this setting is changed totrue the command will be executed automatically. This can speed up the user's workflow, but use with caution.

Auto Close determines if the integrated terminal will close automatically after the commit command is executed. This setting if meant to work withAuto Commit set totrue.

Multiline Commit forces aBash shell to parse the\n character in the commit message. WhenGitmoji Commit opens the prompt for commit message text a multiline commit message can be created. RequiresBash shell.

• Example multiline commit message

🐛 Fix error when protocol is missingFirst, it checks if the protocol is set. If not, it changes the url andadd the basic http protocol on the beginning.Second, it does a "preflight" request and follows all redirects andreturns the last URL. The process then continues with this URL.Resolves #17

• Select🐛 Fix a bug :bug: from the commit type prompt
• Enter the following into the commit message prompt

Fix error when protocol is missing\n\nFirst, it checks if the protocol is set. If not, it changes the url and\nadd the basic http protocol on the beginning.\nSecond, it does a "preflight" request and follows all redirects and\nreturns the last URL. The process then continues with this URL.\n\nResolves #17

Custom Emoji determines if a custom emoji mapping should be used instead of the defaultGitmoji Commit mapping. This custom mapping should be provided to theCustom Emoji Map setting.

Custom Emoji Map is an array ofGitmoji Commit objects that can be used instead of the defaults. This setting allows the user to define their own emojis and commit types to suit the needs of them and/or their team. The objects provided must be in the appropriate shape. Each object should has three required properies.

To use this custom mapping make sure to setCustom Emoji totrue. Having this additional setting allows users to save a custom mapping in their options but also use the default mapping depending on the needs of their current project.

Follow changes to this extension in theChangelog

• Gitmoji Commit Message

• Gitmoji Cheat Sheet

Download Gitmoji Commit

Source Code

Inspired byGitmoji

benjaminadk	darkhist	AnandChowdhary