https://github.com/kevin940726/emoji-cz

:sparkles: A commitizen emoji adapter.
https://github.com/kevin940726/emoji-cz

commitizen commitizen-adapter emoji git

Last synced: about 3 hours ago
JSON representation

:sparkles: A commitizen emoji adapter.

• Host: GitHub
• URL: https://github.com/kevin940726/emoji-cz
• Owner: kevin940726
• License: mit
• Created: 2017-03-04T14:32:50.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-06T16:11:04.000Z (almost 2 years ago)
• Last Synced: 2024-05-13T14:42:48.851Z (6 months ago)
• Topics: commitizen, commitizen-adapter, emoji, git
• Language: JavaScript
• Homepage: http://npm.im/emoji-cz
• Size: 199 KB
• Stars: 64
• Watchers: 4
• Forks: 10
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# emoji-cz

> A [commitizen](https://github.com/commitizen/cz-cli) emoji adapter.

[![NPM](https://nodei.co/npm/emoji-cz.png?downloads=true&stars=true)](https://nodei.co/npm/emoji-cz/)

```

? Select the type of change that you're committing: (Use arrow keys)

❯ ✨  Feat:      A new feature

  🐛  Fix:       A bug fix

  📚  Docs:      Documentation only changes

  🎨  Style:     Changes that do not affect the meaning of the code

  🔨  Refactor:  A code change that neither fixes a bug nor adds a feature

  🚀  Perf:      A code change that improves performance

  🚨  Test:      Adding missing tests or correcting existing tests

```

## Demo

Just check out the commit history above :point_up:

## Installation

```

yarn global add emoji-cz

# OR

# npm install --global emoji-cz

# set as default adapter globally

echo '{ "path": "emoji-cz" }' > ~/.czrc

```

## Usage

Simply use `git cz` instead of `git commit` when committing. See the doc of [Commitizen](https://github.com/commitizen/cz-cli) for more info.

## Settings

You can overwrite the settings in 3 different ways, it will apply the config by this order:

1. `package.json`

2. `.cz.json`

3. `.czrc`

```js

// in package.json

"config": {

  "commitizen": {

    // ...

    "emoji-cz": {

      // Overwrite types prompted to the command line.

      "types": {

        "Fix": {

          "emoji": "🐝", // overwrite "Fix" emoji to a bee

          "name": "Bug", // overwrite "Fix" name to "Bug"

          "description": "Dirty bug" // overwrite description of "Fix"

        },

        // add a new type "Chore"

        "Chore": {

          "emoji": "❓",

          "description": "Other changes that don't modify src or test files"

        }

      },

      // Overwrite the output commit subject in the specified format.

      // Below is the default format,

      // [emoji] will be replace with the chose type's emoji,

      // [name] will be replace with the chose type's name,

      // [subject] will be replace with the subject you entered.

      // One example output of the format can be: `✨ Feat: initial commit`

      "format": "[emoji] [name]: [subject]"

    }

  }

}

// in .cz.json or .czrc

{

  "emoji-cz": {

    //...

  }

}

```

## Author

Kai Hao 

## License

[MIT](LICENSE)