buzz

The buzz spell checks and tests Buzz sources. Each op finds every .buzz file and runs buzz --check, buzz --test, or the magus interpreter over it.

Runtime name: buzz (source spells/buzz/)

Version probe: none

Passing arguments to ops

Every op is invoked as buzz["<op>"](ctx, opts?). The first argument is the target's context, which is what carries the execution environment; the optional options map shapes the command itself:

Working directory and environment are NOT options: they ride the context, as buzz["<op>"](ctx.withCwd("sub")) and buzz["<op>"](ctx.withEnv({"CGO_ENABLED": "0"})). Only the context reaches the cache key, so an option-table cwd or env would change what the tool did while the key said otherwise - passing either as an option is an error.

Charms (the :charm suffix, e.g. magus run test:rw) are orthogonal: they patch the base argv, while these options add to it. See Charms.

buzz-check

check type-checks every Buzz source without running it (buzz --check). buzz takes one script per invocation, so find feeds xargs one file at a time (-n1; -print0 pairs with -0 for safe paths, and -r skips an empty set - the same -print0 | xargs pattern the bash spell uses for shellcheck.

Command: sh -c find . -name '*.buzz' -print0 | xargs -0 -r -n1 buzz --check

Example

// buzz-check parses every .buzz file: magus run check runs buzz --check over the tree.
import "magus";
import "magus/spell/buzz";

magus\project({ "spells": [buzz] });

export fun check(ctx: magus\Context, args: [str]) > void {
    buzz["buzz-check"](ctx);
}

buzz-test

test runs each source's Buzz test {} blocks (buzz --test).

Command: sh -c find . -name '*.buzz' -print0 | xargs -0 -r -n1 buzz --test

Example

// buzz-test runs the test blocks in every .buzz file via buzz --test.
import "magus";
import "magus/spell/buzz";

magus\project({ "spells": [buzz] });

export fun test(ctx: magus\Context, args: [str]) > void {
    buzz["buzz-test"](ctx);
}

magus-buzz

magus-buzz executes each source through magus buzz, magus's own embedded Buzz engine. It has no check-only mode - executing a file compiles, type-checks, and runs it - so this is the runtime sibling of buzz-check. It invokes "$MAGUS": magus exports MAGUS (the running binary's path, à la GNU Make's $(MAKE)) into every spell subprocess, so this resolves to the current magus even uninstalled / under go run, with no dependence on PATH. (A bare $MAGUS, not ${MAGUS:-magus}: Buzz reads {...} in a string as interpolation, and MAGUS is always set here anyway.)

Command: sh -c find . -name '*.buzz' -print0 | xargs -0 -r -n1 "$MAGUS" buzz

Example

// magus-buzz runs each .buzz file through the magus interpreter.
import "magus";
import "magus/spell/buzz";

magus\project({ "spells": [buzz] });

export fun run_buzz(ctx: magus\Context, args: [str]) > void {
    buzz["magus-buzz"](ctx);
}