Eemoji

<h1 align="center"> eemoji <br><br>

</h1>

This is a tiny CLI tool that automatically adds emojis to your commit messages based on conventional commit types.

• 📦 Easy Install: just install it once and forget about it
• 🛠️ Customizable: you can add your own emojis and trigger words, and change the format of the commit message as per your needs.
• 🫧 Seamless: operates with the prepare-commit-msg git hook, modifying your commit messages every time you make a commit.

[!WARNING] There is a known issue with GitHub Desktop on Windows.

😎 Emojis

Hi, read the README.md first (starting with Install). This emoji table is for quick reference. Btw it's generated from the default.jsonc file.

<details open> <summary><b>Close/open gigantic table</b></summary> <!-- emoji table start -->

| Type | Subtype | Emoji | Description | | ---------- | ---------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------- | | fix | . | 🔧 | general fix | | fix | typo | ✏️ | fixed typo in code, docs, ui, etc. | | fix | bug | 🐛 | fixed a bug | | fix | security | 🔒 | fixed security issues | | chore | . | 🗑️ | did some chores | | chore | release | 🔖 | new release commit (pairs well with bumpp) | | chore | cleanup | 🧹 | cleaned up code, removed logs and debug stuff, made everyting ready for production | | chore | license | 📜 | changed the license | | chore | lint | 🧼 | fixed linting errors | | chore | deps | 📦 | changed dependencies | | chore | readme | 📕,📗,📘,📙 | update the README | | release | | 🔖 | | | cleanup | | 🧹 | | | lint | | 🧼 | | | deps | . | 📦 | added/removed/changed dependencies | | deps | up | ⬆️ | updated dependencies | | deps | down | ⬇️ | downgraded dependencies | | up | | ⬆️ | | | down | | ⬇️ | | | build | . | 🦺 | work regarding build processes | | build | deps | 📦 | dependabot PRs (see the prefix in the dependabot.yml file on how to add an emoji to our friend's PRs) | | docs | . | 📝 | documented something | | docs | readme | 📕,📗,📘,📙 | | | feat | . | ✨ | introduced a new feature | | feat | enhance | 💎 | made something a little better (but still include in release notes) | | enhance | | 💎 | made something a little better (omit from release notes) | | test | | 🧪 | worked on tests | | refactor | | ♻️ | refactored code, achieved the same with less | | init | | 🎉 | started a new project! | | perf | | ⚡ | improved performance, achieved the same faster | | breaking | | 💥 | special type: will be used if the commit contains an exclamation mark (!), indicates breaking changes | | ci | | 🦾 | changed workflow files, CI stuff | | config | | ⚙️ | changed configuration files | | style | | 🎨 | design changes, style changes | | ui | | 🪟 | worked on UI, UX or layout | | text | | 💬 | changed string literals, text content | | revert | | ⏪ | revert a commit | | i18n | | 🌐 | translated something | | security | | 🔒 | | | wip | | 🚧 | wildcard type, works for anything | | add | | ➕ | | | remove | | ➖ | |

<!-- emoji table end --> </details>

🚀 Install

There are two different ways to install eemoji:

• Locally: add it to a node project as a dev dependency. This way you can share it with other contributors.
• Globally: install it globally to use it everywhere, <u>not just in node projects</u>. Note that you will need to initialize it in other repository for it to work there.

Thanks to the postinstall script, after installing eemoji locally/globally, it will automatically create the git hook for the current repo. This means it will just work, but it's especially useful when other users are going to contribute to your repository.

[!TIP] If you use yarn or pnpm, which do not run postinstall scripts by default, you need to run eemoji init manually. Besides that, you can create a prepare script in your package.json, so that it will be run automatically for others who contribute to your repository:

{
  "scripts": {
    "prepare": "eemoji init -c none"
  }
}

Local

npm i -D eemoji

Global

npm i -g eemoji

[!NOTE] For eemoji to work in a repository you still need to run the init command once, so that it can install the git hook there as well.

📖 Usage

**After installing it, just create