Class Commitizen

Hierarchy

Component
- Commitizen

Index

Constructors

Properties

options? project config

Methods

postSynthesize preSynthesize synthesize of

Constructors

constructor

new Commitizen(project, options?): Commitizen
Parameters
- project: GitHooksEnabledProject
- Optional options: CommitizenOptions
  Optional
Returns Commitizen

Overrides Component.constructor

Properties

`Optional` `Readonly` options

options?: CommitizenOptions

project

project: GitHooksEnabledProject

`Static` config

config: {
path: string;
} = ...

Type declaration

path: string

Methods

postSynthesize

postSynthesize(): void
Called after synthesis. Order is not guaranteed.

Returns void

Inherited from Component.postSynthesize

preSynthesize

preSynthesize(): void
Returns void

Overrides Component.preSynthesize

synthesize

synthesize(): void
Synthesizes files to the project output directory.

Returns void

Inherited from Component.synthesize

`Static` of

of(project): undefined | Commitizen
Returns the singletone component of a project or undefined if there is none.
Parameters
- project: GitHooksEnabledProject
Returns undefined | Commitizen

Generated using TypeDoc