Development Workflow

Building

cargo check --workspace                                # type-check
cargo build --workspace                                # full build

Testing

cargo test --workspace                                 # run all tests

The episode corpus is the primary correctness tool — it runs brink against golden episodes generated by the C# ink runtime and asserts the behavior matches. The commands, the ratchet, and the per-case diagnostics are documented in Test Corpus.

Linting

cargo clippy --workspace --all-targets -- -D warnings  # lint
cargo fmt --all -- --check                             # format check
cargo fmt --all                                        # format fix

Lint policy

unsafe_code, unwrap_used, expect_used, panic, todo, print_stdout, print_stderr are denied in library crates
Clippy pedantic is enabled (with targeted allows for noise)
Tests are exempt from unwrap/expect/dbg/print restrictions (via clippy.toml)

Determinism

Never iterate HashMap keys/values where order affects output. Sort or use BTreeMap. This applies to all output-producing code paths — bytecode emission, line table construction, name table serialization, and test output.

Keyboard shortcuts