megasanjay-devmoji
v1.2.1
Published
Enhance your conventional commits with gitmoji
Downloads
704
Maintainers
Readme
:sparkles: Devmoji
Using Conventional Commits :star: as a standard for your commit messages, makes Semantic Versioning :bookmark: as easy as can be, with tools like Conventional Changelog :page_facing_up:, Standard Version :bookmark: and Semantic Release :package::rocket:
Devmoji is a command line tool that adds color :rainbow: to conventional commits, using emojis inspired by Gitmoji :stuck_out_tongue_winking_eye:
Some of the things Devmoji can do:
- emojify: convert input between diferent emoji
formats
unicode
,shortcode
anddevmoji
. devmoji are easy to remember aliases like::test:
,:refactor:
,:docs:
,:security
instead of hard to remember emoji codes - git commit: install a
prepare-commit-msg
commit hook to :sparkles: automagically emojify and lints your commit message - git log: emojify and colorify the output of
git log
even for projects not using emojis
What does it look like?
- see the commit messages of the Devmoji github repository
- generated Devmoji CHANGELOG.md
:package: Installation
Install with npm
or yarn
globally
npm install -g megasanjay-devmoji
yarn global add megasanjay-devmoji
locally inside your project. use with
npx megasanjay-devmoji
npm install --dev megasanjay-devmoji
yarn add --dev megasanjay-devmoji
See --edit
for information on how to setup a git commit
hook.
:boom: Usage
megasanjay-devmoji --help
$ megasanjay-devmoji --help
Usage: megasanjay-devmoji [options]
Options:
-c|--config <file> location of the devmoji.config.js file
-l|--list list all known devmojis
-t|--text <text> text to format. reads from stdin when omitted
--lint lint the conventional commit. disabled for --log
-f|--format <format> format should be one of: unicode, shortcode, devmoji (default: "unicode")
--commit automatically add a devmoji to the conventional commit header (default: true)
--no-commit do not process conventional commit headers
-e|--edit read last commit message from .git/COMMIT_EDITMSG in the git root
--log format conventional commits in text similar to git log
--color use colors for formatting. Colors are enabled by default, unless output is piped to another command (default: true)
--no-color don't use colors
--version output the version number
-h, --help output usage information
megasanjay-devmoji
emojify
Emojify text using --text
or piping it to stdin
. Input can be a combination
using any valid format. Output formats:
| Format | Description |
| ----------- | ---------------------------------------------------------------- |
| shortcode
| outputs Github Markdown short codes like :sparkles:
:rocket:
|
| unicode
| outputs the emoji unicode symbols like :sparkles: :rocket: |
| devmoji
| outputs the devmoji shortcodes like :feat:
:chore-release:
|
| strip
| removes all emoji from the input |
The default format is
unicode
, since this can be used pretty much everywhere and has the shortest text length (relevant for commit messages)
$ echo "This is a :test: of the first :release: :boom: ✨" | devmoji --format shortcode
This is a :rotating_light: of the first :rocket: :boom: :sparkles:
$ echo "This is a :test: of the first :release: :boom: :sparkles:" | devmoji --format unicode
This is a 🚨 of the first 🚀 💥 ✨
$ echo "🚀 :boom: :sparkles:" | devmoji --format devmoji
:chore-release: :breaking: :feat:
$ echo "test 🚀 :boom: :sparkles: :security:" | devmoji --format strip
test
megasanjay-devmoji --commit
Automagically :sparkles: emojifies a conventional commit message of the format
type(scope): something useful
, using the following pseudo code:
if (exists(":type-scope:")) return emoji(":type-scope:")
if (exists(":type:") && exists(":scope:"))
return emoji(":type:") + emoji(":scope:")
if (exists(":type:")) return emoji(":type:")
example ouput:
$ echo "feat: added a new feature :smile:" | devmoji --commit
feat: ✨ added a new feature 😄
$ echo "chore(release): 1.1.1" | devmoji --commit
chore(release): 🚀 1.1.1
$ echo "fix(security): upgraded lodash" | devmoji --commit
fix(security): 🐛 🔒 upgraded lodash
megasanjay-devmoji --lint
Lints your commit message to see if they are valid conventional commits
megasanjay-devmoji --edit
Formats and saves your current commit message .git/COMMIT_EDITMSG
. This is
only really useful as a prepare-commit-msg
or commit-msg
hook.
When to use what hook?
prepare-commit-msg
: use this if you do not use Devmnojis--lint
option and want to use it with something like commitlint instead.commit-msg
: use this hook if you also want to use Devmoji for linting
Configuration using Husky
# make sure husky hooks are installed
$ npx husky install
# add a hook for devmoji
$ npx husky add .husky/prepare-commit-msg "npx megasanjay-devmoji -e --lint"
Configuration using Yorkie
// package.json
{
"gitHooks": {
"prepare-commit-msg": "megasanjay-devmoji -e --lint"
}
}
If you installed Devmoji locally in your project as a dev dependency, then use something like
npx --no-install megasanjay-devmoji -e
instead of the commands above.
Alternatively, if you don't want to use Husky or Yorkie, you can manually create the git hooks.
megasanjay-devmoji --log
Works similar to --commit
, but formats type(scope): something useful
anywhere in the input instead of the beginning of the first line.
This is useful to format the output of git log
. Any git log
option works,
but my favorite alias is:
$ git log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --decorate --date=short
I'll use my alias
git l
, instead of the above, for clarity. Themegasanjay-devmoji --format strip
is only for demonstration purposes, since all devmoji commits already have emoji
using
megasanjay-devmoji --log
>
megasanjay-devmoji --list
To get a list of all available Devmoji, run with --list
. (see also
Default Devmoji)
:gear: Configuration
megasanjay-devmoji
uses the config file as specified with the --config
option, or looks for devmoji.config.js
in the following paths:
- current directory
- parent directory that contains a
package.json
file - parent directory that is a
git
repository - home directory
Example Config File
module.exports = {
// extra types used in commit messages
types: ["lint"],
// custom devmoji
devmoji: [
// use :boom: instead of :sparkles: for the type 'feat'
{ code: "feat", emoji: "boom" },
// add a custom devmoji
{
code: "fail",
emoji: "poop",
description: "something bad happened",
},
// add a new devmoji based on an existing gitmoji. description will be taken from the gitmoji
{
code: "css",
gitmoji: "art",
},
// the emoji from the gitmoji can be overriden as well
{
code: "config",
gitmoji: "wrench",
emoji: "gear",
},
],
}
Default Devmoji Reference
| Emoji | Devmoji Code | Description |
| ---------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------- |
| :sparkles: | :feat:
| feat: a new feature |
| :bug: | :fix:
| fix: a bug fix |
| :books: | :docs:
| docs: documentation only changes |
| :art: | :style:
| style: changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| :recycle: | :refactor:
| refactor: a code change that neither fixes a bug nor adds a feature |
| :zap: | :perf:
| perf: a code change that improves performance |
| :rotating_light: | :test:
| test: adding missing or correcting existing tests |
| :wrench: | :chore:
| chore: changes to the build process or auxiliary tools and libraries such as documentation generation |
| :rocket: | :chore-release:
| chore(release): code deployment or publishing to external repositories |
| :link: | :chore-deps:
| chore(deps): add or delete dependencies |
| :package: | :build:
| build: changes related to build processes |
| :construction_worker: | :ci:
| ci: updates to the continuous integration system |
| :rocket: | :release:
| code deployment or publishing to external repositories |
| :lock: | :security:
| Fixing security issues. |
| :globe_with_meridians: | :i18n:
| Internationalization and localization. |
| :boom: | :breaking:
| Introducing breaking changes. |
| :gear: | :config:
| Changing configuration files. |
| :heavy_plus_sign: | :add:
| add something |
| :heavy_minus_sign: | :remove:
| remove something |