配置 - 控制相关 ​

alias ​

• 描述 : 定义常用的 commit message 别名
• 类型 : { [alias: string]: string }
• 默认 : { fd: "docs: fix typos" }

scopes ​

• 描述 : 自定义选择 模块范围 命令行显示信息
• 类型 : string[] | Array<{ name: string, value?: string }>
• 默认 : []

scopeOverrides ​

• 描述 : 自定义选择了特定类型后 覆盖模块范围 命令行显示信息
• 类型 :
  { [type: string]: string[] | Array<{ name: string, value?: string }> } | undefined
• 默认 : undefined
• 例子 : scopeOverrides: { "test": ["e2eTest", "unitTest"] }
• 使用 : 针对选择 特定 的 commit 类型 type 后选择模块范围时显示 自定义的模块范围选择

scopeFilters ​

• 描述 : 根据 scope.value 过滤模块范围中的选项
• 类型 : string[]
• 默认 : [".DS_Store"]

enableMultipleScopes ​

• 描述 : 是否开启在选择 模块范围 时使用多选模式
• 类型 : boolean
• 默认 : false

scopeEnumSeparator ​

• 描述 : 在多选模式下 模块范围 之间的分隔符
• 类型 : string
• 默认 : ,

allowCustomScopes ​

• 描述 : 是否在选择 模块范围 显示自定义选项(custom)
• 类型 : boolean
• 默认 : true
• 使用 : 没有使用 commitlint并且想在选择中关闭自定义选项

allowEmptyScopes ​

• 描述 : 是否在选择 模块范围 显示为空选项(empty)
• 类型 : boolean
• 默认 : true

markBreakingChangeMode ​

• 描述 : 添加额外的问题重大变更(BREAKING CHANGES)提问，询问是否需要添加 "!" 标识于头部
• 使用 : 当你想添加 ! 标识于头部，表明该 commit 为重大变更时，请使用该选项
• 类型 : boolean
• 默认 : false

allowBreakingChanges ​

• 描述 : 允许出现 重大变更(BREAKING CHANGES)的特定 type
• 类型 : string[]
• 默认 : ['feat', 'fix']

useAI ​

• 描述 : 是否使用 OpenAI API 自动生成提交信息 subject ^简短描述
• 类型 : boolean
• 默认 : false

aiModel ​

• 描述 : 选择你想使用的 AI 模型
• 示例 : gpt-3.5-turbo | gpt-4 | gpt-4o | gpt-4o-mini
  ... (并且可以使用 /chat/completions endpoint 的兼容模型)
  例如：GitHub 模型 和本地模型 (Ollama)
• 类型 : string
• 默认值 : gpt-4o-mini

aiNumber ​

• 描述 : 如果大于 1 ，则会让 OpenAI 返回指定的多个选项，并开启选择模式
• 类型 : number
• 默认 : 1

aiDiffIgnore ​

• 描述 : 设置忽略目标文件的 diff 信息数据发送 OpenAI API
• 类型 : string[]
• 默认 : [ "package-lock.json", "yarn.lock", "pnpm-lock.yaml" ]
• 例子 : [ "pnpm-lock.yaml", "docs/public" ]

aiQuestionCB ​

• 描述 : 该回调函数可利用已知的信息自定义设置发送给 OpenAI 的请求文案
• 类型 : (param: GenerateAIPromptType) => string

export interface GenerateAIPromptType {
  type: string
  defaultScope?: string
  maxSubjectLength?: number
  upperCaseSubject?: boolean
  diff?: string
}

export interface GenerateAIPromptType {
  type: string
  defaultScope?: string
  maxSubjectLength?: number
  upperCaseSubject?: boolean
  diff?: string
}

• 例子 :

module.exports = {
  aiQuestionCB: ({ maxSubjectLength, diff }) => `Write an insightful and concise Git commit message in the present tense for the following Git diff code, without any prefixes, and no longer than ${maxSubjectLength} characters.: \`\`\`diff\n${diff}\n\`\`\``,
}

module.exports = {
  aiQuestionCB: ({ maxSubjectLength, diff }) => `Write an insightful and concise Git commit message in the present tense for the following Git diff code, without any prefixes, and no longer than ${maxSubjectLength} characters.: \`\`\`diff\n${diff}\n\`\`\``,
}

module.exports = {
  aiQuestionCB: ({ maxSubjectLength, diff }) => `用完整句子为以下 Git diff 代码写一个有见解并简洁的 Git 中文提交消息，不加任何前缀，并且内容不能超过 ${maxSubjectLength} 个字符: \`\`\`diff\n${diff}\n\`\`\``,
}

module.exports = {
  aiQuestionCB: ({ maxSubjectLength, diff }) => `用完整句子为以下 Git diff 代码写一个有见解并简洁的 Git 中文提交消息，不加任何前缀，并且内容不能超过 ${maxSubjectLength} 个字符: \`\`\`diff\n${diff}\n\`\`\``,
}

upperCaseSubject ​

• 描述 : 是否自动将简短描述(subject)第一个字符进行大写处理
• 类型 : boolean
• 默认 : false

breaklineNumber ​

• 描述 : 详细描述(body)和重大变更(BREAKING CHANGES)中根据字符超过该数值自动换行
• 类型 : number
• 默认 : 100
• 使用 : 当没有使用 commitlint 并要使用规范化时

breaklineChar ​

• 描述 : 详细描述(body)和重大变更(BREAKING CHANGES)中换行字符
• 类型 : string
• 默认 : "|"

issuePrefixes ​

• 描述 : 自定义选择issue前缀
• 类型 : Array<{ value: string, name: string }>
• 默认 : [{ value: "closed", name: "closed: ISSUES has been processed" }]

allowCustomIssuePrefix ​

• 描述 : 是否在选择 ISSUE 前缀 显示自定义选项(custom)
• 类型 : boolean
• 默认 : true

allowEmptyIssuePrefix ​

• 描述 : 是否在选择 ISSUE 前缀 显示为跳过选项(skip)
• 类型 : boolean
• 默认 : true

maxHeaderLength ​

• 描述 : 定义commit message中的 header 长度, 给予在命令行中的校验信息
• 类型 : number
• 默认 : Infinity
• 使用 : 当没有使用 commitlint 并要使用规范化时

maxSubjectLength ​

• 描述 : 定义commit message中的 subject 长度, 给予在命令行中的校验信息
• 类型 : number
• 默认 : Infinity
• 使用 : 当没有使用 commitlint，并要使用规范化时

minSubjectLength ​

• 描述 : 定义commit message中的 subject 长度, 给予在命令行中的校验信息
• 类型 : number
• 默认 : 0
• 使用 : 当没有使用 commitlint，并要使用规范化时

useCommitSignGPG ​

• 描述 : 使用 GPG 签名 commit message
• 类型 : boolean
• 默认 : false

skipQuestions ​

• 描述 : 自定义选择指定的问题不显示
• 类型 : Array<'scope' | 'body' | 'breaking' | 'footerPrefix' | 'footer' | 'confirmCommit'>
• 默认 : []

formatMessageCB ​

• 描述 : 使用此回调函数可自定义最终的 message 格式以及输出
• 类型 : (messageMod: CommitMessageOptions) => string

interface CommitMessageOptions {
  type: string
  scope: string
  emoji: string
  markBreaking: string
  subject: string
  defaultHeader: string
  body: string
  breaking: string
  footer: string
  defaultMessage: string
}

interface CommitMessageOptions {
  type: string
  scope: string
  emoji: string
  markBreaking: string
  subject: string
  defaultHeader: string
  body: string
  breaking: string
  footer: string
  defaultMessage: string
}

• 默认 : ({ defaultMessage }) => defaultMessage