📦 Installation

npm install -g devmojiyarn global add devmoji

npm install --dev devmojiyarn add --dev devmoji

💥 Usage

devmoji --help

$devmoji --helpUsage: 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

devmoji emojify

$echo"This is a :test: of the first :release: :boom: ✨"| devmoji --format shortcodeThis is a :rotating_light: of the first :rocket: :boom: :sparkles:$echo"This is a :test: of the first :release: :boom: :sparkles:"| devmoji --format unicodeThis is a 🚨 of the first 🚀 💥 ✨$echo"🚀 :boom: :sparkles:"| devmoji --format devmoji:chore-release: :breaking: :feat:$echo"test 🚀 :boom: :sparkles: :security:"| devmoji --format striptest

devmoji --commit

if(exists(":type-scope:"))returnemoji(":type-scope:")if(exists(":type:")&&exists(":scope:"))returnemoji(":type:")+emoji(":scope:")if(exists(":type:"))returnemoji(":type:")

$echo"feat: added a new feature :smile:"| devmoji --commitfeat: ✨ added a new feature 😄$echo"chore(release): 1.1.1"| devmoji --commitchore(release): 🚀 1.1.1$echo"fix(security): upgraded lodash"| devmoji --commitfix(security): 🐛 🔒 upgraded lodash

devmoji --lint

devmoji --edit

# make sure husky hooks are installed$ npx husky install# add a hook for devmoji$ npx husky add .husky/prepare-commit-msg"npx devmoji -e --lint"

// package.json{"gitHooks":{"prepare-commit-msg":"devmoji -e --lint"}}

devmoji --log

$ 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

devmoji --list

⚙️ Configuration

Example Config File

module.exports={// extra types used in commit messagestypes:["lint"],// custom devmojidevmoji:[// 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