Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Commitlint

The Commitlint component adds conventional-changelog/commitlint to your project, which checks if your commit messages meet the conventional commit format.

Hierarchy

  • Component
    • Commitlint

Index

Constructors

Properties

Methods

Constructors

constructor

  • adds commitlint to the project

    Parameters

    • project: NodeProject

      the project to add to

    • Optional options: Dynamic<CommitlintOptions, NodeProject>

      see CommitLintOptions

    Returns Commitlint

Properties

Optional commitlintrc

commitlintrc?: JsonFile

options

options: DeepRequired<Omit<CommitlintOptions, "commitlintOptions">> & Required<Pick<CommitlintOptions, "commitlintOptions">>

Readonly project

project: Project

Static defaultOptions

defaultOptions: Dynamic<DeepRequired<Omit<CommitlintOptions, "commitlintOptions">> & Required<Pick<CommitlintOptions, "commitlintOptions">>, NodeProject> = ...

Methods

postSynthesize

  • postSynthesize(): void

  • Called after synthesis. Order is not guaranteed.

    Returns void

preSynthesize

  • preSynthesize(): void

  • Called before synthesis.

    Returns void

synthesize

  • synthesize(): void

  • Synthesizes files to the project output directory.

    Returns void

Generated using TypeDoc