Building

Prerequisites

• Rust 1.92+ (2024 edition)
• wasm32-unknown-unknown target (for WASM builds)

Optional tools (provisioned by .mise.toml):

• cargo-nextest: Parallel test runner (used by CI)
• cargo-llvm-cov: Code coverage
• cargo-deny: Dependency auditing
• mdbook: Documentation site

Build Commands

The workspace defines cargo aliases in .cargo/config.toml:

# Build
cargo build               # Debug build
cargo build-release       # Release build

# Check
cargo check-all           # Check all targets

# Test
cargo test-all            # Run all tests (nextest)
cargo test-lib            # Run library tests only (faster)
cargo test test_name      # Run a specific test

# Quality
cargo fmt --all           # Format code
cargo fmt-check           # Check formatting
cargo lint                # Clippy lints
cargo docs                # Generate documentation

QA Pipeline

After completing any coding task, run the full QA suite:

cargo fmt --all && cargo lint && cargo test-all

CI runs these additional checks:

CI sets RUSTFLAGS="-D warnings" to treat warnings as errors. The same flag is enabled in .cargo/config.toml for local development.

Cross-Platform Builds

CI verifies compilation on 10 targets:

Documentation

Build the API documentation:

cargo docs

Build this mdbook site:

cd docs && mdbook build

Serve locally with auto-reload:

cd docs && mdbook serve