Nibbling Pastry Monster

    @beisen/bsapp-cz-emoji

    0.0.1 • Public • Published

    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

    Install

    npm i @beisen/bsapp-cz-emoji

    DownloadsWeekly Downloads

    3

    Version

    0.0.1

    License

    MIT

    Unpacked Size

    14.7 kB

    Total Files

    5

    Last publish

    Collaborators

    • albert-zhang
    • liugenpeng
    • beisencorp
    • lgm
    • neozw