Auto Git Emoji

commit-msg

#!/usr/bin/python3.6
"""
Loosely based on gitmoji https://gitmoji.carloscuesta.me/
WIP: 🚧
Meant for work in progress. Incomplete or still an idea
NEW: ✨
New functionality that is working. Meant as a checkpoint
FIX: 🔧
Minor code changes/ Refactors that are steps before a NEW feature
BUG: 🐞
Bugfix, it explais itself
ART: 🎨
Cosmetic changes based on linting. (Docstrings, typos, bad variable names, etc)
TDD: ✔️
Test related changes. Create/Delete/Update tests
merge: 🔄
Merge related changes
docs: 📚
Add documentation

Any combination of this three structures will work, case insensitive

* Opening -> [ ( { :
* Content -> wip new fix bug art tdd
* Closing -> ] ) } :
"""
import sys
import re


# Will match things like [wip: too, but anyway ...
# who would want to see that instead of a beautiful emoji?
full_regex = re.compile(
    r'([{|:|\[|\(](wip|new|fix|bug|art|tdd|doc|merge)[}|:|\]|\)])',
    re.IGNORECASE,
)

replacement_icons = {
    'wip': '🚧',
    'new': '✨',
    'fix': '🔧',
    'bug': '🐞',
    'art': '🎨',
    'tdd': '✔️',
    'merge': '🔄',
    'doc': '📚',
}


def insert_emojis(commit_file):
    with open(commit_file, 'r') as f:
        commit_message = f.read()
    for full_match, emoji_str in set(full_regex.findall(commit_message)):
        commit_message = commit_message.replace(
            full_match,
            replacement_icons[emoji_str.lower()],
        )
    with open(commit_file, 'w') as f:
        f.write(commit_message)


def main():
    commit_file = sys.argv[1]
    with open(commit_file, 'r') as f:
        backup = f.read()
    try:
        insert_emojis(commit_file)
    except Exception:
        print("Could not place emojis in commit message")
        with open(commit_file, 'w') as f:
            f.write(backup)
    finally:
        sys.exit(0)


main()

To setup in your git run
git config --global core.hooksPath /path/to/your/centralized/hooks
and inside that folder create this file with commit-msg as the name and add execution permissions (chmod +x commit-msg).
You can then check everything went ok with git config --list and you should see the new property value

thanks a lot!!!