Skip to content

Custom Emojis

Leonardo Ascione edited this page Feb 26, 2019 · 3 revisions

This package allows for custom emojis, or customizing behaviour for provided ones, using emojis config property as introduced in the readme.

The emojis key must be an object, where each key is the type (added, edited or disabled), and value is the emoji type configuration.

Each type maps to a conventional-changelog "type", i.e. fix, feat,Β ci.

This project uses cosmiconfig, so you can put your emoji customization in the favolosoEmoji key in your package.json, or just create a .favolosoEmoji.json, favolosoEmoji.config.js, etc. file in your project directory.

Sample

{
  "favolosoEmoji": {
    "emojis": {
      "fix": {
        "emoji": "🐞",
        "heading": "🐞 Fixes"
      },
      "chore": false,
      "change": {
        "emoji": "πŸ’Ό",
        "inChangelog": true,
        "heading": "πŸ’Ό Changes",
        "bump": "patch",
        "aliases": ["πŸ‘œ"],
        "typeAliases": ["changes"]
      }
    }
  }
}
Clone this wiki locally