Developer Guide

This guide covers environment setup, building, testing, and documentation for typstyle.

• Rust stable toolchain with cargo
• Node.js and yarn (for web assets)
• cargo-nextest and cargo-insta (for testing)
• shiroa (for documentation)

Clone and build the project:

1
git clone https://github.com/typstyle-rs/typstyle.git
2
cd typstyle
3
cargo build              # Debug build
4
cargo build --release    # Release build

1
git clone https://github.com/typstyle-rs/typstyle.git
2
cd typstyle
3
cargo build              # Debug build
4
cargo build --release    # Release build

Install required tools:

1
# For testing
2
cargo binstall cargo-nextest cargo-insta
3
# For building wasm
4
cargo binstall wasm-pack
5
# For documentation
6
cargo binstall shiroa

1
# For testing
2
cargo binstall cargo-nextest cargo-insta
3
# For building wasm
4
cargo binstall wasm-pack
5
# For documentation
6
cargo binstall shiroa

• crates/typstyle/crates/typstyle/ — formatter CLI
• crates/typstyle-core/crates/typstyle-core/ — core formatting logic
• crates/typstyle-consistency/crates/typstyle-consistency/ — consistency test framework
• crates/typstyle-typlugin/crates/typstyle-typlugin/ — typst plugin for embedded usage
• crates/typstyle-wasm/crates/typstyle-wasm/ — wasm bindings
• tests/tests/ — integration tests and fixtures
• docs/docs/ — documentation source (based on shiroa and written in typst)
• contrib/typstyle-embedded/contrib/typstyle-embedded/ — typstyle as typst package
• playground/playground/ — web-based interactive playground