README.md

GitMojo

Emojilify all the things \o/

Install

Install GitMojo globally

yarn global add gitmojo
# or npm install gitmojo -g

Initialize GitMojo in your project

cd  my-project
gitmojo init --doc
# gitmojo init

Husky's hook configuration

Update Husky's configuration with prepare-commit-msg git hook

"husky": {
  "hooks": {
    "prepare-commit-msg": "gitmojo --all"
  }
}

Defaults Emojis

See GITMOJO.md for defaults emojis
Edit .gitmojorc.json in you project to fit your needs
Use gitmojo -d to regenerate the documentation file

Requirements

• NodeJS >= 12.13.1
• Husky >= 4.2.3

TODOS

• [] check if Husky package is installed
• [] debug with windows EOL
• [] remove usage of husky