Class Husky

adds husky to the project, which manages git hooks

see https://typicode.github.io/ and https://git-scm.com/docs/githooks

Hierarchy

Component
- Husky

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Husky(project: NodeProject, options?: Dynamic<HuskyOptions, NodeProject>): Husky

Overrides Component.constructor

adds husky to the project

Parameters
- project: NodeProject
  
  the project to add to
- Optional options: Dynamic<HuskyOptions, NodeProject>
  
  see HuskyOptions
Returns Husky

Properties

Optional hooks

hooks?: Partial<Record<HuskyHook, TextFile>>

options

options: DeepRequired<HuskyOptions>

Readonly project

project: Project

Static defaultOptions

defaultOptions: Dynamic<DeepRequired<HuskyOptions>, NodeProject> = ...

Methods

addHook

addHook(hook: HuskyHook, ...lines: string[]): void

adds the lines to the specified hook

Parameters
- hook: HuskyHook
  
  to hook to add to
- Rest ...lines: string[]
  
  the new lines to add
Returns void

deleteHook

deleteHook(hook: HuskyHook): void

removes the specified hook

Parameters
- hook: HuskyHook
  
  the hook to delete
Returns void

getHookNames

getHookNames(): string[]

get the list of all the hook names

Returns string[]
the hook names

overrideHook

overrideHook(hook: HuskyHook, ...lines: string[]): void

replaces the specified hook

Parameters
- hook: HuskyHook
  
  the hook to override
- Rest ...lines: string[]
  
  the new lines
Returns void

postSynthesize

postSynthesize(): void

Inherited from Component.postSynthesize

Called after synthesis. Order is not guaranteed.

Returns void

preSynthesize

preSynthesize(): void

Overrides Component.preSynthesize

adds husky to the project

Returns void

synthesize

synthesize(): void

Inherited from Component.synthesize

Synthesizes files to the project output directory.

Returns void

Generated using TypeDoc