Options - Engineering 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 BREAKING CHANGES
• type : string[]
• default : ["feat", "fix"]

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 : "|"

skipQuestions #

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

issuePrefixs #

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

allowCustomIssuePrefixs #

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

allowEmptyIssuePrefixs #

• description : whether to display an empty option when selecting ISSUES prefixs (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

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