README.md

😜 Gitmoji Browser Extension

The Gitmoji extension to easily search and copy gitmojis 😜

🎉 Installation

Install the extension according to your browser:

• Chrome web store
• Firefox add-ons
• Edge add-ons

🧩 Features

• 🔍 Search for a specific gitmoji's code/emoji by name or description
• 🐕 Detect the gitmojis present on the current tab
• ➕ Inject 🔀 gitmoji in front of the commit title of GitHub/GitLab pull-request (⚙️)
• 🌔 Dark/light mode (⚙️)
• ❌ Close extension's popup after a gitmoji is saved in the clipboard (⚙️)
• ❓ Show gitmoji's description on mouse over or focus (⚙️)

Features with the (⚙️) can be modified in the settings page.

⚖️ Permissions

activeTab

Detect the gitmojis present on the current tab. Used to access some hardcoded URLs detailed below:

Access your data for github.com
Access your data for gitlab.com

Both are used for the feature "Inject 🔀 gitmoji in front of the commit title of GitHub/GitLab pull-request"

We restricted these permissions to the minimum by using specific URLs:

• https://github.com/*/*/pull/*
• https://gitlab.com/*/*/-/merge_requests/*

It can be checked on the injectMergeGitmoji.js file.

Storage

The storage is used to keep the settings preferences (see 🧩 Features > Through the settings panel).

✨ Usage (with keyboard shortcuts)

• toggle the extension button or use the shortcut Alt+G (⌥+G for mac)
• search emoji names or descriptions (from the website)
• use tab and Shift+tab to navigate between the shortcodes and emojis
• press Enter to copy

🦄 Contributing

All remarks are welcome so feel free to open an issue 😉 Wants to collaborate? Please read the contributing guidelines.

📄 License

The code is available under the MIT license.

---

Made with ❤ by @johannchopin and @lyokolux