Skip to content

relizy / CommitlintResult

Interface: CommitlintResult ​

Defined in: src/core/commitlint/lint.ts:37

Properties ​

changelogTitle? ​

optional changelogTitle?: string

Defined in: src/core/commitlint/lint.ts:45

Title of the changelog section of the commit, undefined when it does not appear in the changelog


commit ​

commit: CommitlintCommit

Defined in: src/core/commitlint/lint.ts:38


gitCommit? ​

optional gitCommit?: GitCommit

Defined in: src/core/commitlint/lint.ts:47

The commit as parsed by relizy, undefined when the header is not a conventional commit


ignored ​

ignored: boolean

Defined in: src/core/commitlint/lint.ts:40

Ignored commits (merge, fixup, release...) are not linted


problems ​

problems: CommitlintProblem[]

Defined in: src/core/commitlint/lint.ts:43


suggestion? ​

optional suggestion?: CommitlintSuggestion

Defined in: src/core/commitlint/lint.ts:49

A fixed header, when some errors of the header can be fixed safely


valid ​

valid: boolean

Defined in: src/core/commitlint/lint.ts:42

No error (warnings allowed)

Released under the MIT License.