Class Lefthook

Pjid

lefthook

Hierarchy

GitHooksManager
- Lefthook

Index

Constructors

Properties

config markdownlint? project

Methods

addCommand addScript postSynthesize preSynthesize synthesize of

Constructors

constructor

new Lefthook(project, options?): Lefthook
Parameters
- project: GitHooksEnabledProject
- Optional options: LefthookOptions
  Optional
Returns Lefthook

Overrides GitHooksManager.constructor

Properties

config

config: LefthookConfig

`Optional` `Readonly` markdownlint

markdownlint?: Markdownlint

project

project: GitHooksEnabledProject

Methods

addCommand

addCommand(hookName, command): void
Parameters
- hookName: GitClientHook
- command: LefthookCommandOptions
Returns void

addScript

addScript(hookName, script): void
Parameters
- hookName: GitClientHook
- script: LefthookScriptOptions
Returns void

postSynthesize

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

Returns void

Inherited from GitHooksManager.postSynthesize

preSynthesize

preSynthesize(): void
Called before synthesis.

Returns void

Overrides GitHooksManager.preSynthesize

synthesize

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

Returns void

Inherited from GitHooksManager.synthesize

`Static` of

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

Overrides GitHooksManager.of

Generated using TypeDoc