A command line tool to make emojify your boring commit messages. 🌟
- Emojis are cool. 😎
- A lot of text is boring. 😒
- People like emojis. 😄
- People don't like to read. 😡
$ npm install -g commemoji
Use commemoji wherever you'd use git commit -m.
Want to standardize? Are you fixing a bug, writing docs, adding tests, or something common? Use the -k flag with a commit type to get the emoji that best represents your commit. Check out Atom's contributing guide for more info.
$ commemoji -k "Fix bug causing random emojis to be returned." "bug"
- 🐛 "bug" | "b" - When fixing a bug.
- 🎨 "formatting" | "f" - When improving the format/structure of the code.
- 📝 "docs" | "d" - When writing docs.
- 🐎 "perf" | "p" - When improving performance.
- 🐧 "linux" | "l" - When fixing something on Linux.
- 🍎 "mac" | "m" - When fixing something on Mac OS.
- 🏁 "windows" | "w" - When fixing something on Windows.
- 🔥 "removal" | "r" - When removing code or files.
- 💚 "ci" - When fixing the CI build.
- ✅ "tests" | "t" - When adding tests.
- 🔒 "security" | "s" - When dealing with security.
- ⬆️ "upgrade dep" | "ud" - When upgrading dependencies.
- ⬇️ "downgrade dep" | "dd" - When downgrading dependencies.
- 👕 "lint" - When removing/adding linter warnings.
Want to express something specific with your commit? Just want that 💩? Use the -s flag and specify a query after your commit message.
$ commemoji -s "This code is legit, but this message is boring." "fire"
Not sure how you feel about the commit? Just supply your message and we'll give you an emoji that describes your commit message, or a random one if we can't find one that does.
$ commemoji "This code is legit, but this message is boring."
Use the -r flag to replace any keywords in your commit message with emojis. This flag can be used with any of the other flags or by itself.
Thanks to @muan and emojilib for providing an awesome resource for GitHub-supported emojis. 👏 I frequently used their emoji searcher before creating this tool.
MIT ©️ Joe Martella