relizy / RuleContext

Interface: RuleContext

Defined in: src/core/commitlint/rules.ts:20

What a rule receives to check a commit.

Properties

allowedScopes?

optional allowedScopes?: string[]

Defined in: src/core/commitlint/rules.ts:28

undefined when any scope is allowed

---

commit

commit: CommitlintCommit

Defined in: src/core/commitlint/rules.ts:22

---

config

config: ResolvedRelizyConfig

Defined in: src/core/commitlint/rules.ts:21

---

gitCommit?

optional gitCommit?: GitCommit

Defined in: src/core/commitlint/rules.ts:25

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

---

packages

packages: WorkspacePackage[]

Defined in: src/core/commitlint/rules.ts:26

---

parts

parts: CommitMessageParts

Defined in: src/core/commitlint/rules.ts:23

---

value

value: unknown

Defined in: src/core/commitlint/rules.ts:30

Configured value of the rule, or its default value