配置 - 显示相关 #

messages #

• 描述 : 自定义命令行提问信息
• 例子 :
  

{
  "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 #

• 描述 : set prompt inquirer theme color
• 类型 : string
• 默认 : "" (⇒ cyan 青色)

export ___X_CMD_THEME_COLOR_CODE="38;5;043"

export ___X_CMD_THEME_COLOR_CODE="38;5;043"

types #

• 描述 : 自定义选择类型提示
• 类型 : Array<{ name: string; value: string; emoji?: string }>
• 例子 :
  types: [{value: 'feat', name: 'feat: 新增功能 | A new feature', emoji: ':sparkles:'}]

useEmoji #

• 描述 : 是否开启 commit message 带有 Emoji 字符。
• 类型 : boolean
• 默认 : false

emojiAlign #

• 描述 : 设置 Emoji 字符 的 位于头部位置
• 类型 : "left" | "center" | "right"
• 默认 : "center"
• 示例 : <left> type(scope): <center> subject <right>

typesAppend #

• 描述 : 在默认 types 的基础上，添加额外的 types
• 类型 : Array<{ name: string; value: string; emoji?: string }>
• 使用 : 只想额外添加少量types，不想添加臃肿的默认配置，或改变默认配置的显示顺序时使用。
• 默认 : []
• 例子 :
  

{
  "typesAppend": [
    { "value": "workflow", "name": "workflow:  Workflow changes" },
    { "value": "*!", "name": "*!:        BREAKING CHANGES" }
  ]
}

{
  "typesAppend": [
    { "value": "workflow", "name": "workflow:  Workflow changes" },
    { "value": "*!", "name": "*!:        BREAKING CHANGES" }
  ]
}

typesSearchValueKey #

• 描述 : 默认 types 列表的模糊搜索针对 value 字段。设置为 false 后针对 name 字段
• 类型 : boolean
• 默认 : true

customScopesAlign #

• 描述 : 设置 选择范围 中 为空选项(empty) 和 自定义选项(custom) 的 位置
• 类型 : "top" | "bottom" | "top-bottom" | "bottom-top"
• 默认 : "bottom"

customScopesAlias #

• 描述 : 自定义 选择范围 中 自定义选项(custom) 在命令行中显示的 名称
• 类型 : string
• 默认 : custom

emptyScopesAlias #

• 描述 : 自定义 选择范围 中 为空选项(empty) 在命令行中显示的 名称
• 类型 : string
• 默认 : empty

customIssuePrefixsAlign #

• 描述 : 设置 选择 issue 前缀 中 跳过选项(skip) 和 自定义选项(custom) 的 位置
• 类型 : "top" | "bottom" | "top-bottom" | "bottom-top"
• 默认 : "top"

customIssuePrefixsAlias #

• 描述 : 自定义 选择 issue 前缀 中 自定义选项(custom) 在命令行中显示的 名称
• 类型 : string
• 默认 : custom

emptyIssuePrefixsAlias #

• 描述 : 自定义 选择 issue 前缀 中 跳过选项(skip) 在命令行中显示的 名称
• 类型 : string
• 默认 : skip

confirmColorize #

• 描述 : 确定提交中模板 commit message 是否着色
• 类型 : boolean
• 默认 : true

defaultType #

• 描述 : 如果 defaultType 与在选择范围列表项中的 value 相匹配就会进行星标置顶操作。
• 类型 : string
• 默认 : ""

defaultScope #

• 描述 : 如果 defaultScope 与在选择范围列表项中的 value 相匹配就会进行星标置顶操作。
• 类型 : string
• 默认 : ""
• 额外 : 在 自定义范围 中是否使用显示默认值

提示 ⇒ 查看小窍门

defaultSubject #

• 描述 : 在 简短描述 中是否使用显示默认值
• 类型 : string
• 默认 : ""
• 使用 : 初始化补全模板，可使用 Tab 或者 → 进行快速补全；亦可直接使用 Enter 输出模板。

提示 ⇒ 查看小窍门

defaultBody #

• 描述 : 在 详细描述 中是否使用显示默认值
• 类型 : string
• 默认 : ""
• 使用 : 初始化补全模板，可使用 Tab 或者 → 进行快速补全；亦可直接使用 Enter 输出模板。

defaultFooterPrefix #

• 描述 : 在 自定义ISSUE前缀 中是否使用显示默认值
• 类型 : string
• 默认 : ""
• 使用 : 初始化补全模板，可使用 Tab 或者 → 进行快速补全；亦可直接使用 Enter 输出模板。

defaultIssues #

• 描述 : 在 输入ISSUE 中是否使用显示默认值
• 类型 : string
• 默认 : ""
• 使用 : 初始化补全模板，可使用 Tab 或者 → 进行快速补全；亦可直接使用 Enter 输出模板。

提示 ⇒ 查看小窍门