relizy / CommitlintConfig

Interface: CommitlintConfig

Defined in: src/types.ts:1458

Properties

customRules?

optional customRules?: Record<string, CommitlintCustomRule>

Defined in: src/types.ts:1481

Rules written as functions, keyed by name. Their level is set in rules and defaults to error.

---

defaultIgnores?

optional defaultIgnores?: boolean

Defined in: src/types.ts:1492

Ignore merge commits, fixup!, squash! and amend! commits, and the release commits of relizy.

Default

true

---

helpUrl?

optional helpUrl?: string

Defined in: src/types.ts:1502

URL printed with the errors, e.g. the commit guidelines of the team.

---

ignores?

optional ignores?: (RegExp | ((message) => boolean))[]

Defined in: src/types.ts:1486

Messages to ignore, in addition to the default ones: a regular expression tested against the header, or a function receiving the raw message.

---

packages?

optional packages?: string[]

Defined in: src/types.ts:1464

Glob patterns of directories to treat as workspace packages for the scopes, in addition to monorepo.packages, e.g. apps that are never released.

Example

['apps/*']

---

rules?

optional rules?: CommitlintRulesConfig

Defined in: src/types.ts:1476

Level and value of the built-in and custom rules.

Example

{ 'header-max-length': ['error', 200], 'scope-required': ['error', 'when-bumping'] }

---

scopes?

optional scopes?: string[]

Defined in: src/types.ts:1471

Scopes allowed in addition to the workspace packages (short name, full name or folder) and the scopeMap keys. In standalone mode, scopes are free unless this list is set.

Example

['ci', 'deps', 'release']

---

title?

optional title?: boolean

Defined in: src/types.ts:1498

In the CI of a pull/merge request, also lint its title, which becomes the commit message of a squash merge. Overridden by --title and --no-title.

Default

false