Commitizen adapter formatting commit messages using emojis.
Clone or download
Latest commit 55a7b2c Jul 1, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib ⬆️ Update gitmojis from upstream (#19) Jul 1, 2018
.editorconfig birth Dec 17, 2016
.gitattributes birth Dec 17, 2016
.gitignore birth Dec 17, 2016
index.js 🐛 fix bug where adapter crashes if there is no .czrc (#17) May 4, 2018
license birth Dec 17, 2016
package-lock.json 1.1.2 Jul 1, 2018
package.json 1.1.2 Jul 1, 2018
readme.md 📚 fix typo: Gitemoji ➡️ Gitmoji (#18) Jul 1, 2018

readme.md

cz-emoji

Commitizen adapter formatting commit messages using emojis.

cz-emoji allows you to easily use emojis in your commits using commitizen.

? Select the type of change you are committing: (Use arrow keys)
❯ feature   🌟  A new feature
  fix       🐞  A bug fix
  docs      📚  Documentation change
  refactor  🎨  A code refactoring change
  chore     🔩  A chore change

Install

npm install --global cz-emoji

# set as default adapter for your projects
echo '{ "path": "cz-emoji" }' > ~/.czrc

Usage

$ git cz

Customize

By default cz-emoji comes preconfigured with the Gitmoji types.

But you can customize things on a project basis by adding a configuration section in your package.json:

{
  "config": {
    "cz-emoji": {}
  }
}

Types

An Inquirer.js choices array:

{
  "config": {
    "cz-emoji": {
      "types": [
        {
          "emoji": "🌟",
          "code": ":star2:",
          "description": "A new feature",
          "name": "feature"
        }
      ]
    }
  }
}

The value property must be the emoji itself.

Scopes

An Inquirer.js choices array:

{
  "config": {
    "cz-emoji": {
      "scopes": [
        "home",
        "accounts",
        "ci"
      ]
    }
  }
}

Examples

License

MIT © Nicolas Gryman