Skip to main content

Module hooks

Module hooks 

Source
Expand description

What rk reads about a project’s git hooks, for its reports alone.

rk runs no hook manager. rk integrate asks git to run the clone’s pre-merge-commit hook, and git runs whatever the project installed. This module only reads: which hook manager wrote each installed hook, for rk doctor, and which nested hook configuration prek would run as a project of its own, for rk status. Neither answer changes what any verb runs.

SATISFIES tool-requirements:the-doctor-reports-the-hook-runner SATISFIES tool-requirements:a-nested-hook-configuration-is-reported

Structs§

Installed
One installed hook: its event and who wrote it.

Enums§

Writer
Who wrote one installed hook, read from the header its manager writes.

Constants§

EVENTS
The hook events the landed block and the integration gate use.

Functions§

installed
The hooks installed in the repository at dir, through git’s own path to its hooks directory, core.hooksPath included; None outside a repository.
unexcluded_nested_configs
The nested hook configurations of target that prek would run.