cz-emoji

> Commitizen adapter formatting commit messages using emojis.

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

``sh
? 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

Globally

`bash
npm install --global cz-emoji

set as default adapter for your projects


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

Locally

`bash
npm install --save-dev cz-emoji
`

Add this to your package.json:

`json
"config": {
"commitizen": {
"path": "cz-emoji"
}
}
`

Usage

`sh
$ git cz
`

Customization

By default cz-emoji comes ready to run out of the box. Uses may vary, so there are a few configuration options to allow fine tuning for project needs.

$3

Configuring cz-emoji can be handled in the users home directory (~/.czrc) for changes to impact all projects or on a per project basis (package.json). Simply add the config property as shown below to the existing object in either of the locations with your settings for override.

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

$3

#### Types

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

An [Inquirer.js] choices array:

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

#### Scopes

An [Inquirer.js] choices array:

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

#### Symbol

A boolean value that allows for an using a unicode value rather than the default of Gitmoji markup in a commit message. The default for symbol is false.

`json
{
"config": {
"cz-emoji": {
"symbol": true
}
}
}
`

#### Skip Questions

An array of questions you want to skip:

`json
{
"config": {
"cz-emoji": {
"skipQuestions": ["scope", "issues"]
}
}
}
`

You can skip the following questions: scope, body, issues, and breaking. The type and subject questions are mandatory.


#### Customize Questions

An object that contains overrides of the original questions:

`json
{
"config": {
"cz-emoji": {
"questions": {
"body": "This will be displayed instead of original text"
}
}
}
}
`

#### Customize the subject max length

The maximum length you want your subject has

`json
{
"config": {
"cz-emoji": {
"subjectMaxLength": 200,
}
}
}
`

Examples

- https://github.com/Falieson/TRAM

Commitlint

Commitlint can be set to work with this package by leveraging the package https://github.com/arvinxx/commitlint-config-gitmoji.

`bash
npm install --save-dev commitlint-config-gitmoji
`

_commitlint.config.js_

`js
module.exports = {
extends: ['gitmoji'],
parserPreset: {
parserOpts: {
headerPattern: /^(:\w:)(?:\s)(?:\((.?)\))?\s((?:.(?=\())|.)(?:\(#(\d*)\))?/,
headerCorrespondence: ['type', 'scope', 'subject', 'ticket']
}
}
}
``

Other projects

- Fauda: configuration made simple.
- Commitizen Emoji: Commitizen adapter formatting commit messages using emojis.
- Reading Time: Medium's like reading time estimation.

License

MIT © Nicolas Gryman

[commitizen]: https://github.com/commitizen/cz-cli
[inquirer.js]: https://github.com/SBoudrias/Inquirer.js/