Skip to content

PromptScript API


Interface: HookDefinition

Defined in: formatters/src/hook-adapters.ts:51

A parsed hook definition from the

Hooks

block.

Properties

command?

optional command?: string[]

Defined in: formatters/src/hook-adapters.ts:59

Command arguments (non-empty array).


continueOnFailure?

optional continueOnFailure?: boolean

Defined in: formatters/src/hook-adapters.ts:69

Whether to continue if the hook fails.


cwd?

optional cwd?: string

Defined in: formatters/src/hook-adapters.ts:63

Project-root or project-relative working directory.


enabled?

optional enabled?: boolean

Defined in: formatters/src/hook-adapters.ts:71

Whether the hook is enabled.


event

event: PortableHookEvent

Defined in: formatters/src/hook-adapters.ts:55

Portable event name.


id

id: string

Defined in: formatters/src/hook-adapters.ts:53

Stable hook ID (from object key).


matcher?

optional matcher?: string

Defined in: formatters/src/hook-adapters.ts:57

Tool name matcher pattern (optional).


script?

optional script?: HookScriptDefinition

Defined in: formatters/src/hook-adapters.ts:61

Portable repository-local script.


statusMessage?

optional statusMessage?: string

Defined in: formatters/src/hook-adapters.ts:67

Status message shown during execution.


targets?

optional targets?: Partial\<Record\<HookTarget, HookTargetOverride>>

Defined in: formatters/src/hook-adapters.ts:73

Target-specific overrides merged on top of the portable definition.


timeoutMs?

optional timeoutMs?: number

Defined in: formatters/src/hook-adapters.ts:65

Timeout in milliseconds.