relizy / CommitlintBuiltInRules
Interface: CommitlintBuiltInRules
Defined in: src/types.ts:1317
The built-in rules of relizy commitlint, with the type of their value (never when the rule has no value).
See
https://relizy.dev/commitlint/rules
Properties
body-breaking-change
body-breaking-change:
never
Defined in: src/types.ts:1389
A breaking change is only declared with ! in the header or a BREAKING CHANGE: footer, as relizy bumps the major version wherever breaking change: appears.
Default
'error'body-changelog-lint
body-changelog-lint:
never
Defined in: src/types.ts:1383
The commit, rendered as in the changelogs, passes the lint of the changelogs.
Default
'error'body-leading-blank
body-leading-blank:
never
Defined in: src/types.ts:1368
A blank line separates the header from the body.
Default
'error'body-markdown
body-markdown:
never
Defined in: src/types.ts:1378
The markdown of the body is valid: code blocks closed, links with a URL.
Default
'error'body-no-headings
body-no-headings:
never
Defined in: src/types.ts:1373
The body has no markdown headings, which would break the changelog.
Default
'error'header-format
header-format:
never
Defined in: src/types.ts:1322
The header follows type(scope)!: subject.
Default
'error'header-max-length
header-max-length:
number
Defined in: src/types.ts:1327
Maximum length of the header.
Default
['error', 500]no-breaking
no-breaking:
never
Defined in: src/types.ts:1394
Breaking changes are not allowed.
Default
'off'scope-enum
scope-enum:
never
Defined in: src/types.ts:1337
The scope is a workspace package, a scopeMap key or one of commitlint.scopes.
Default
'error'scope-matches-files
scope-matches-files:
never
Defined in: src/types.ts:1348
The scope designates a package touched by the commit.
Default
'warn'scope-required
scope-required:
"always"|"never"|"when-bumping"
Defined in: src/types.ts:1343
The scope is required ('always'), forbidden ('never'), or required on the commits bumping a version ('when-bumping').
Default
['off', 'always']subject-case
subject-case:
never
Defined in: src/types.ts:1353
The subject starts with a lowercase letter.
Default
'error'subject-full-stop
subject-full-stop:
never
Defined in: src/types.ts:1358
The subject does not end with a period.
Default
'error'subject-meaningful
subject-meaningful:
object
Defined in: src/types.ts:1363
The subject describes the change, with a minimum of words or characters.
minLength?
optionalminLength?:number
minWords?
optionalminWords?:number
Default
['error', { minWords: 2, minLength: 15 }]type-enum
type-enum:
string[]
Defined in: src/types.ts:1332
The type is one of the relizy types, or one of the extra types given as value.
Default
'error'