Class Husky

Hierarchy

GitHooksManager
- Husky

Index

Constructors

Properties

commitizen? lintStaged? markdownlint? project

Methods

createHook postSynthesize preSynthesize synthesize of

Constructors

constructor

new Husky(project, options?): Husky
Parameters
- project: GitHooksEnabledProject
- Optional options: HuskyOptions
  Optional
Returns Husky

Overrides GitHooksManager.constructor

Properties

`Optional` `Readonly` commitizen

commitizen?: Commitizen

`Optional` `Readonly` lintStaged

lintStaged?: LintStaged

`Optional` `Readonly` markdownlint

markdownlint?: Markdownlint

project

project: GitHooksEnabledProject

Methods

createHook

createHook(hook, command): void
Parameters
- hook: GitClientHook
- command: string[]
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 | Husky
Returns the singletone component of a project or undefined if there is none.
Parameters
- project: GitHooksEnabledProject
Returns undefined | Husky

Overrides GitHooksManager.of

Generated using TypeDoc