relizy / CommitlintOptions

Interface: CommitlintOptions

Defined in: src/commands/commitlint.ts:28

Properties

config?

optional config?: ResolvedRelizyConfig

Defined in: src/commands/commitlint.ts:69

Pre-loaded config

---

configName?

optional configName?: string

Defined in: src/commands/commitlint.ts:66

Custom config file name (e.g. relizy.standalone for relizy.standalone.config.ts)

---

edit?

optional edit?: string | boolean

Defined in: src/commands/commitlint.ts:33

Lint the message of the commit being created: the file given to the commit-msg hook, or .git/COMMIT_EDITMSG when true.

---

force?

optional force?: boolean

Defined in: src/commands/commitlint.ts:64

Replace an existing commit-msg hook with install

---

format?

optional format?: "json" | "text"

Defined in: src/commands/commitlint.ts:58

text for people (colors in a terminal or a CI), json for programs and AI agents

Default

'text'

---

from?

optional from?: string

Defined in: src/commands/commitlint.ts:40

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?

optional install?: boolean

Defined in: src/commands/commitlint.ts:62

Write the commit-msg hook instead of linting

---

logLevel?

optional logLevel?: "error" | "silent" | "warning" | "normal" | "default" | "debug" | "trace" | "verbose"

Defined in: src/commands/commitlint.ts:67

---

message?

optional message?: string

Defined in: src/commands/commitlint.ts:35

Lint this message

---

preview?

optional preview?: boolean

Defined in: src/commands/commitlint.ts:53

Print the changelog entry of each commit

---

quiet?

optional quiet?: boolean

Defined in: src/commands/commitlint.ts:60

In the text format, only print the commits with problems, and the summary

---

title?

optional title?: boolean

Defined in: src/commands/commitlint.ts:51

In the CI of a pull/merge request, also lint its title, which becomes the commit message of a squash merge

Default

config.commitlint.title

---

to?

optional to?: string

Defined in: src/commands/commitlint.ts:45

Last commit of the range

Default

'HEAD'