Development

This guide covers development workflows for contributing to Taxus.

Prerequisites

• Rust — Install Rust
• mdbook — Documentation: cargo install mdbook

Setup

git clone https://github.com/crustyrustacean/taxus.git
cd taxus
cargo build

Running Tests

# Run all tests (238+ tests)
cargo test

# Run tests for a specific crate
cargo test -p taxus

# Run unit tests only
cargo test --lib

# Run integration tests only
cargo test --test config_loading

Building

# Build static site (plain SSG)
cargo run -- build --dir my-site

# Build with islands support (WASM client is compiled and embedded automatically)
cargo run --features islands -- build --dir my-site

# Build release binary
cargo build --release

Development Server

# Start server with auto-reload
cargo run -- serve --dir my-site --open

Documentation

cd docs
mdbook serve

Open http://localhost:3000 to view.

Code Commands

Logging

Control log output with CLI flags or RUST_LOG:

# Default: info level
cargo run -- build

# Verbose: debug level
cargo run -- build --verbose

# Quiet: errors only
cargo run -- build --quiet

# Custom via RUST_LOG
RUST_LOG=debug cargo run -- build
RUST_LOG=taxus_lib=trace cargo run -- build

Add logging to code:

#![allow(unused)]
fn main() {
use tracing::{info, debug, warn, error};

fn build_site() {
    info!("Building site");
    debug!("Processing content");
    
    // Structured fields
    info!(pages = 5, sections = 2, "Build complete");
}
}

Workspace Structure

taxus/
├── taxus-client/    # WASM hydration client
├── taxus-common/    # Shared Yew components
├── taxus-generator/ # SSG library and CLI
└── docs/            # mdBook documentation

Contributing

1. Fork the repository
2. Create a feature branch
3. Make changes
4. Run tests: cargo test
5. Run linter: cargo clippy
6. Format: cargo fmt
7. Submit a pull request