Options - Control Related ​

alias ​

• description : define commonly used commit message alias
• type : { [alias: string]: string }
• default : { fd: "docs: fix typos" }

scopes ​

• description : custom selection module scope command line display information
• type : string[] | Array<{ name: string, value?: string }>
• default : []

scopeOverrides ​

• description : After customizing a specific type, override module scope command line display information
• type :
  { [type: string]: string[] | Array<{ name: string, value?: string }> } | undefined
• default : undefined
• example : scopeOverrides: { "test": ["e2eTest", "unitTest"] }
• use : Displays custom module scope selection when selecting module scope after selecting specific commit type : type

scopeFilters ​

• description : Filter select of prompt to select module scopes by the scope.value
• type : string[]
• default : [".DS_Store"]

enableMultipleScopes ​

• description : Whether to enable the use of multiple scopes mode
• type : boolean
• default : false

scopeEnumSeparator ​

• description : Separator between scopes in multiple scopes mode
• type : string
• default : ,

allowCustomScopes ​

• description : whether to display custom options when selecting module scope (custom)
• type : boolean
• default : true
• use : not using commitlint and want to turn off custom options in select.

allowEmptyScopes ​

• description : whether to display an empty option when selecting module scope (empty)
• type : boolean
• default : true

markBreakingChangeMode ​

• description : Add an extra BREAKINGCHANGE question asking if you need to add the "!" mark in the header
• use : When you want to add the ! mark in the header, Highlight that the commit message belongs to BREAKINGCHANGE. you can use this option.
• type : boolean
• default : false

allowBreakingChanges ​

• description : a specific type that allows display BREAKING CHANGES prompt
• type : string[]
• default : ["feat", "fix"]

useAI ​

• description : Turn on use OpenAI API to auto generate subject ^{short description} for commit message mode
• type : boolean
• default : false

aiModel ​

• description: Choose the AI model you want to use
• examples: gpt-3.5-turbo | gpt-4 | gpt-4o | gpt-4o-mini
  ... (and models compatible with the /chat/completions endpoint)
  For example: GitHub models and local models (Ollama)
• type: string
• default: gpt-4o-mini

aiNumber ​

• description : If >1 will turn on select mode, select generate options like returned by OpenAI
• type : number
• default : 1

aiDiffIgnore ​

• description : To ignore selection diff codes when sending AI API requests
• type : string[]
• default : [ "package-lock.json", "yarn.lock", "pnpm-lock.yaml" ]
• example : [ "pnpm-lock.yaml", "docs/public" ]

aiQuestionCB ​

• description : Use the callback fn can customize edit AI question content
• type : (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
}

• example :

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\`\`\``,
}

upperCaseSubject ​

• description : Whether to automatically capitalize the first character of the short description (subject)
• type : boolean
• default : false

breaklineNumber ​

• description : body and BREAKING CHANGES the line wraps automatically according to the character exceeding this value
• type : number
• default : 100
• use : When commitlint is not used and normalization is to be used

breaklineChar ​

• description : newline characters in detailed descriptions (body) and breaking changes (BREAKING CHANGES)
• type : string
• default : "|"

issuePrefixes ​

• description : custom select issue prefix
• type : Array<{ value: string, name: string }>
• default : [{ value: "closed", name: "closed: ISSUES has been processed" }]

allowCustomIssuePrefix ​

• description : whether to display custom options when selecting ISSUES prefix (custom)
• type : boolean
• default : true

allowEmptyIssuePrefix ​

• description : whether to display an empty option when selecting ISSUES prefix (skip)
• type : boolean
• default : true

maxHeaderLength ​

• description: Define the length of the header in the commit message, giving the verification information on the command line
• type: number
• default: Infinity
• use : when commitlint is not used and normalization is to be used

maxSubjectLength ​

• description: Define the length of the subject in the commit message, giving the verification information on the command line
• type: number
• default: Infinity
• use : When commitlint is not used and normalization is to be used

minSubjectLength ​

• description: Define the length of the subject in the commit message, giving the verification information on the command line
• type: number
• default : 0
• use : When commitlint is not used and normalization is to be used

useCommitSignGPG ​

• description : use GPG sign commit message
• type : boolean
• default : false

skipQuestions ​

• description : The question specified by the custom selection is not displayed
• type : Array<'scope' | 'body' | 'breaking' | 'footerPrefix' | 'footer' | 'confirmCommit'>
• default : []

formatMessageCB ​

• description : Use the callback fn can custom finally message formatter
• type : (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
}

• default : ({ defaultMessage }) => defaultMessage