boxxy's rules loader. loadRules checks a rules checkout's rules.yaml against the concepts and the phase kinds boxxy compiles in, builds the plug-in registry, and gives the loaded rules a version. example/ holds the v1 rules file and its prompts.

The package does no I/O: the caller reads the checkout and passes in its commit hash and its files' bytes.

Install

Install the package from npm with Bun:

bun add @boxxy/rules

The package runs on Bun 1.3 or newer.

Features

• loadRules, which returns the loaded rules, or every rejection with its file, its path in the file and its reason (the pipeline).
• The rules version, a content hash of the commit, the files the loader read, each concept pin and each phase kind (the rules version).

Documentation

The rules design says why rules live in git, and 02-types.ts gives the shape of the loaded rules.