@yuriazevedo/cz-emoji
v1.2.2
Published
My Commitizen adapter
Downloads
13
Maintainers
Readme
cz-emoji
My Commitizen adapter
Installation
yarn add commitizen @yuriazevedo/cz-emoji -D
Usage example
In package.json
:
{
"config": {
"cz-emoji": {},
"commitizen": {
"path": "./node_modules/@yuriazevedo/cz-emoji"
}
}
}
Configuration Options
Types
An Inquirer.js choices array:
{
"config": {
"cz-emoji": {
"types": [
{
"emoji": "🌟",
"code": ":star2:",
"description": "A new feature",
"name": "feature"
}
]
}
}
}
Scopes
An Inquirer.js choices array:
{
"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 true.
{
"config": {
"cz-emoji": {
"symbol": false
}
}
}
Skip Questions
An array of questions you want to skip:
{
"config": {
"cz-emoji": {
"skipQuestions": ["scope", "issues"]
}
}
}
You can skip the following questions: scope
, body
and issues
. The type
and subject
questions are mandatory.
Customize Questions
An object that contains overrides of the original questions:
{
"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
{
"config": {
"cz-emoji": {
"subjectMaxLength": 200
}
}
}