Skip to content
On this page

Options - Display Related

messages

  • description : custom command line question information
  • example :
json
{
  "messages": {
    "type": "Select the type of change that you're committing:",
    "scope": "Denote the SCOPE of this change (optional):"
    // ...
  }
}
{
  "messages": {
    "type": "Select the type of change that you're committing:",
    "scope": "Denote the SCOPE of this change (optional):"
    // ...
  }
}

themeColorCode

  • description : set prompt inquirer theme color
  • type : string
  • default : "" (⇒ cyan color)

TIP



If you don't want to use the theme color of the configuration record, you can add a line to the profile file such as ~/.bashrc or ~/.zshrc, which will have a higher priority:

sh
export ___X_CMD_THEME_COLOR_CODE="38;5;043"
export ___X_CMD_THEME_COLOR_CODE="38;5;043"

types

  • description : custom selection type prompt
  • type : Array<{ name: string; value: string; emoji?: string }>
  • example :
    types: [{value: 'feat', name: 'feat: A new feature', emoji: ':sparkles:'}]

TIP

If you want to use Emoji, you need enable userEmoji configuration item.
And need to add Emoji Code, you can find the corresponding characters in: https://gitmoji.dev/ or emoji-cheat-sheet to supplement emoji.

useEmoji

  • description : Whether to enable commit messages with Emoji characters.
  • type : boolean
  • default : false

TIP

Try running command to enable output emoji mode in the current session

  • Commitizen CLI: emoji=1 cz
  • cz-git CLI: czg emoji

emojiAlign

  • description : Set the location of Emoji in header
  • type : "left" | "center" | "right"
  • default : "center"
  • example: <left> type(scope): <center> subject <right>

typesAppend

  • description : Add extra types to default types
  • type : Array<{ name: string; value: string; emoji?: string }>
  • use : Use when you don't want to add bloated defaults and don't want to adjust the default order in configuration. Only want to add a little part of types.
  • default : []
  • example :
json
{
  "typesAppend": [
    { "value": "workflow", "name": "workflow:  Workflow changes" },
    { "value": "*!", "name": "*!:        BREAKING CHANGES" }
  ]
}
{
  "typesAppend": [
    { "value": "workflow", "name": "workflow:  Workflow changes" },
    { "value": "*!", "name": "*!:        BREAKING CHANGES" }
  ]
}

typesSearchValue

  • description : Default types list fuzzy search value key. Set false will search name key.
  • type : boolean
  • default : true

scopesSearchValue

  • description : Default scopes list fuzzy search name key. Set true will search value key.
  • type : boolean
  • default : false

customScopesAlign

  • description : Set the location of empty option (empty) and custom option (custom) in selection range
  • type : "top" | "bottom" | "top-bottom" | "bottom-top"
  • default : "bottom"

customScopesAlias

  • description : Customize the name displayed on the command line for the custom option (custom) in the selection range
  • type : string
  • default : custom

emptyScopesAlias

  • description : Customize the name displayed on the command line if the empty option (empty) in the selection range
  • type : string
  • default : empty

customIssuePrefixAlign

  • description : Set the location of skip option (skip) and custom option (custom) in select issue prefix
  • type : "top" | "bottom" | "top-bottom" | "bottom-top"
  • default : "top"

customIssuePrefixAlias

  • description : custom select the issue prefix in the custom option (custom) to display the name on the command line
  • type : string
  • default : custom

emptyIssuePrefixAlias

  • description : Customize the name displayed on the command line in the skip option (skip) in the select issue prefix
  • type : string
  • default : skip

confirmColorize

  • description : Determines whether the template commit message is colored in the commit
  • type : boolean
  • default : true




TIP

Using default value can produce many ways to make the tool more suitable for you or your team's habits, see the recipes.

defaultType

  • description : pin type item the top of the types list (match types item value)
  • type : string
  • default : ""

defaultScope

  • description : pin scope item the top of the scope list (match scopes item value)
  • type : string | string[] For checkbox mode. items will automatic checked
  • default : ""
  • other : Initialize the completion template in custom scope. you can use Tab or to quickly complete; you can also use the Enter output template directly.

⇒ see the recipes

defaultSubject

  • description : Whether to use the display default value in the short description
  • type : string
  • default : ""
  • use : Initialize the completion template, you can use Tab or to quickly complete; you can also use the Enter output template directly.

⇒ see the recipes

defaultBody

  • description : Whether to use the display default value in the detailed description
  • type : string
  • default : ""
  • use : Initialize the completion template, you can use Tab or to quickly complete; you can also use the Enter output template directly.

defaultFooterPrefix

  • description : Whether to use the display default value in the custom ISSUE prefix
  • type : string
  • default : ""
  • use : Initialize the completion template, you can use Tab or to quickly complete; you can also use the Enter output template directly.

defaultIssues

  • description : Whether to use the display default value in the input ISSUE
  • type : string
  • default : ""
  • use : Initialize the completion template, you can use Tab or to quickly complete; you can also use the Enter output template directly.

⇒ see the recipes

I just try my best to make thing well, Could you give a star ⭐