🌟 A command line tool to make emojify your boring commit messages.
JavaScript TypeScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
bin
source
spec
.gitattributes
.gitignore
.travis.yml
LICENSE
README.md
package.json
tsconfig.json
typings.json

README.md

commemoji

npm version Build Status js-semistandard-style

A command line tool to make emojify your boring commit messages. 🌟

Why?

  • Emojis are cool. 😎
  • A lot of text is boring. πŸ˜’
  • People like emojis. πŸ˜„
  • People don't like to read. 😑

Install

$ npm install -g commemoji

Usage

Use commemoji wherever you'd use git commit -m.

An emoji with purpose

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"

Common commit types

  • πŸ› "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.

A desired emoji

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"

A descriptive emoji

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."

Replace keywords with emojis

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

Thanks to @muan and emojilib for providing an awesome resource for GitHub-supported emojis. πŸ‘ I frequently used their emoji searcher before creating this tool.

License

MIT ©️ Joe Martella