gitmoji Bash/ZSH plugin

README.md

gitmoji chooser

This command will let you choose a "gitmoji" and pre-fill a git commit -m command for you, all without leaving the terminal

requirements

requires fzf to be installed and available in the $PATH

Bash

paste the contents of gitmoji.bash in ~/.bashrc``, or source` the file

do not execute it as a script, it will not work

ZSH

installation

place file in ~/.oh-my-zsh/custom/plugins/gitmoji/gitmoji.plugin.zsh

usage

use command gitmoji to choose an emoji, and the plugin will pre-fill a git commit -m command for you, which you can edit before executing

gitmoji.bash

# generate with
# curl -L https://github.com/carloscuesta/gitmoji/raw/master/packages/gitmojis/src/gitmojis.json|jq -r '.gitmojis[] | "\(.emoji):\(.description)"'

gitmojis=$(cat << EOF | tr '\n' '@'
🎨:Improve structure / format of the code.
⚡️:Improve performance.
🔥:Remove code or files.
🐛:Fix a bug.
🚑️:Critical hotfix.
✨:Introduce new features.
📝:Add or update documentation.
🚀:Deploy stuff.
💄:Add or update the UI and style files.
🎉:Begin a project.
✅:Add, update, or pass tests.
🔒️:Fix security or privacy issues.
🔐:Add or update secrets.
🔖:Release / Version tags.
🚨:Fix compiler / linter warnings.
🚧:Work in progress.
💚:Fix CI Build.
⬇️:Downgrade dependencies.
⬆️:Upgrade dependencies.
📌:Pin dependencies to specific versions.
👷:Add or update CI build system.
📈:Add or update analytics or track code.
♻️:Refactor code.
➕:Add a dependency.
➖:Remove a dependency.
🔧:Add or update configuration files.
🔨:Add or update development scripts.
🌐:Internationalization and localization.
✏️:Fix typos.
💩:Write bad code that needs to be improved.
⏪️:Revert changes.
🔀:Merge branches.
📦️:Add or update compiled files or packages.
👽️:Update code due to external API changes.
🚚:Move or rename resources (e.g.: files, paths, routes).
📄:Add or update license.
💥:Introduce breaking changes.
🍱:Add or update assets.
♿️:Improve accessibility.
💡:Add or update comments in source code.
🍻:Write code drunkenly.
💬:Add or update text and literals.
🗃️:Perform database related changes.
🔊:Add or update logs.
🔇:Remove logs.
👥:Add or update contributor(s).
🚸:Improve user experience / usability.
🏗️:Make architectural changes.
📱:Work on responsive design.
🤡:Mock things.
🥚:Add or update an easter egg.
🙈:Add or update a .gitignore file.
📸:Add or update snapshots.
⚗️:Perform experiments.
🔍️:Improve SEO.
🏷️:Add or update types.
🌱:Add or update seed files.
🚩:Add, update, or remove feature flags.
🥅:Catch errors.
💫:Add or update animations and transitions.
🗑️:Deprecate code that needs to be cleaned up.
🛂:Work on code related to authorization, roles and permissions.
🩹:Simple fix for a non-critical issue.
🧐:Data exploration/inspection.
⚰️:Remove dead code.
🧪:Add a failing test.
👔:Add or update business logic.
🩺:Add or update healthcheck.
🧱:Infrastructure related changes.
🧑💻:Improve developer experience.
💸:Add sponsorships or money related infrastructure.
🧵:Add or update code related to multithreading or concurrency.
🦺:Add or update code related to validation.
EOF
)

gitmoji() {
        emoji=$(echo $gitmojis | tr '@' '\n'| fzf | cut -d: -f1)
        if [[ -n "$emoji" ]]; then
                echo "chose $emoji"
                bind '"\e[0n": "git commit -m '"'$emoji"'"'; printf '\e[5n'
        fi
}

gitmoji.plugin.zsh

# generate with 
# curl -L https://github.com/carloscuesta/gitmoji/raw/master/packages/gitmojis/src/gitmojis.json|jq -r '.gitmojis[] | "\(.emoji):\(.description)"'

gitmojis=$(cat << EOF
🎨:Improve structure / format of the code.
⚡️:Improve performance.
🔥:Remove code or files.
🐛:Fix a bug.
🚑️:Critical hotfix.
✨:Introduce new features.
📝:Add or update documentation.
🚀:Deploy stuff.
💄:Add or update the UI and style files.
🎉:Begin a project.
✅:Add, update, or pass tests.
🔒️:Fix security or privacy issues.
🔐:Add or update secrets.
🔖:Release / Version tags.
🚨:Fix compiler / linter warnings.
🚧:Work in progress.
💚:Fix CI Build.
⬇️:Downgrade dependencies.
⬆️:Upgrade dependencies.
📌:Pin dependencies to specific versions.
👷:Add or update CI build system.
📈:Add or update analytics or track code.
♻️:Refactor code.
➕:Add a dependency.
➖:Remove a dependency.
🔧:Add or update configuration files.
🔨:Add or update development scripts.
🌐:Internationalization and localization.
✏️:Fix typos.
💩:Write bad code that needs to be improved.
⏪️:Revert changes.
🔀:Merge branches.
📦️:Add or update compiled files or packages.
👽️:Update code due to external API changes.
🚚:Move or rename resources (e.g.: files, paths, routes).
📄:Add or update license.
💥:Introduce breaking changes.
🍱:Add or update assets.
♿️:Improve accessibility.
💡:Add or update comments in source code.
🍻:Write code drunkenly.
💬:Add or update text and literals.
🗃️:Perform database related changes.
🔊:Add or update logs.
🔇:Remove logs.
👥:Add or update contributor(s).
🚸:Improve user experience / usability.
🏗️:Make architectural changes.
📱:Work on responsive design.
🤡:Mock things.
🥚:Add or update an easter egg.
🙈:Add or update a .gitignore file.
📸:Add or update snapshots.
⚗️:Perform experiments.
🔍️:Improve SEO.
🏷️:Add or update types.
🌱:Add or update seed files.
🚩:Add, update, or remove feature flags.
🥅:Catch errors.
💫:Add or update animations and transitions.
🗑️:Deprecate code that needs to be cleaned up.
🛂:Work on code related to authorization, roles and permissions.
🩹:Simple fix for a non-critical issue.
🧐:Data exploration/inspection.
⚰️:Remove dead code.
🧪:Add a failing test.
👔:Add or update business logic.
🩺:Add or update healthcheck.
🧱:Infrastructure related changes.
🧑💻:Improve developer experience.
💸:Add sponsorships or money related infrastructure.
🧵:Add or update code related to multithreading or concurrency.
🦺:Add or update code related to validation.
EOF
)

function gitmoji() {
	emoji=$(echo $gitmojis | fzf | cut -d: -f1)
	if [[ -n "$emoji" ]]; then
		print -z "git commit -m '$emoji"
	fi
}