Skip to content

Development Setup

Set up your development environment for USL.

Prerequisites

  • Rust 1.75+
  • Node.js 18+
  • Git

Clone Repository

git clone https://github.com/usl-lang/usl
cd usl

Build Compiler

cd compiler
cargo build
cargo test

Run Compiler

cargo run -- compile examples/simple.usl

Development Workflow

  1. Create a branch
  2. Make changes
  3. Run tests: cargo test
  4. Format code: cargo fmt
  5. Check lints: cargo clippy
  6. Commit and push
  7. Open pull request

Testing

# Unit tests
cargo test --lib

# Integration tests
cargo test --test '*'

# All tests
cargo test

Documentation

cargo doc --open

Back to Contributing