relizy / CommitlintOptions
Interface: CommitlintOptions
Defined in: packages/relizy/src/commands/commitlint.ts:10
Properties
config?
optionalconfig?:ResolvedRelizyConfig
Defined in: packages/relizy/src/commands/commitlint.ts:51
Pre-loaded config
configName?
optionalconfigName?:string
Defined in: packages/relizy/src/commands/commitlint.ts:48
Custom config file name (e.g. relizy.standalone for relizy.standalone.config.ts)
edit?
optionaledit?:string|boolean
Defined in: packages/relizy/src/commands/commitlint.ts:15
Lint the message of the commit being created: the file given to the commit-msg hook, or .git/COMMIT_EDITMSG when true.
force?
optionalforce?:boolean
Defined in: packages/relizy/src/commands/commitlint.ts:46
Replace an existing commit-msg hook with install
format?
optionalformat?:"json"|"text"
Defined in: packages/relizy/src/commands/commitlint.ts:40
text for people (colors in a terminal or a CI), json for programs and AI agents
Default
'text'from?
optionalfrom?:string
Defined in: packages/relizy/src/commands/commitlint.ts:22
Lint the commits after this ref. Defaults to the merge-base with the target branch of the pull/merge request in CI, otherwise the last tag.
install?
optionalinstall?:boolean
Defined in: packages/relizy/src/commands/commitlint.ts:44
Write the commit-msg hook instead of linting
logLevel?
optionallogLevel?:"silent"|"error"|"warning"|"normal"|"default"|"debug"|"trace"|"verbose"
Defined in: packages/relizy/src/commands/commitlint.ts:49
message?
optionalmessage?:string
Defined in: packages/relizy/src/commands/commitlint.ts:17
Lint this message
preview?
optionalpreview?:boolean
Defined in: packages/relizy/src/commands/commitlint.ts:35
Print the changelog entry of each commit
quiet?
optionalquiet?:boolean
Defined in: packages/relizy/src/commands/commitlint.ts:42
In the text format, only print the commits with problems, and the summary
title?
optionaltitle?:boolean
Defined in: packages/relizy/src/commands/commitlint.ts:33
In the CI of a pull/merge request, also lint its title, which becomes the commit message of a squash merge
Default
config.commitlint.titleto?
optionalto?:string
Defined in: packages/relizy/src/commands/commitlint.ts:27
Last commit of the range
Default
'HEAD'