Skip to main content

Module requirements

Module requirements 

Source
Expand description

The tools rk itself runs, and the check every verb makes before it acts.

A tool here is a dependency of the rk application: the host supplies it, and a verb that runs it checks it at the start of the run, before its first read of a forge and its first write. A missing tool, or one below the floor this binary calls, stops the verb with one error that names every such tool. Which tools a verb checks comes from the verb, its flags, and the target’s record, never from which tools the host happens to carry.

A project’s own hook manager is not here. rk integrate asks git to run the clone’s pre-merge-commit hook, and git runs whatever the project installed.

SATISFIES tool-requirements:a-verb-checks-its-tools-first

Structs§

Unmet
Why one tool cannot serve the verb.

Enums§

Tool
One tool rk runs.

Constants§

GIT_FLOOR
git’s floor: git hook run, which the integration gate runs, first shipped in git 2.36.0.

Functions§

check
Check one tool: it runs, and it answers a version at or above its floor where it has one. None where it serves.
check_program
check for one program a caller already resolved, such as the absolute path of the forge CLI it is about to run, so the check judges that exact file.
check_under_path
check under the search path a child receives, where rk hands the child another PATH than its own, so the check searches as the spawn searches.
refusal
The refusal that names every tool of unmet, for verb, which runs tools.
require
require_in for tools that all run from the caller’s directory.
require_in
Check every tool a verb runs, before it acts.
unmet
Every tool of tools that cannot serve, each once, judged where rk runs it: a tool that runs in the target is checked from target.