Skip to content

BUILD.md

Latest commit

 

History

History
154 lines (103 loc) · 3.02 KB

BUILD.md

File metadata and controls

154 lines (103 loc) · 3.02 KB

Build guide

This document describes how to build Lingua and generate language bindings.

Prerequisites

  • Rust 1.70+ with Cargo
  • Node.js 20+ with pnpm (for TypeScript bindings)
  • Python 3.11+ with uv (for Python bindings)
  • Protocol Buffers compiler (for Google provider)

Quick start

# Install git hooks (recommended for development)
make install-hooks

# Build all bindings
make all

# Run tests
make test

Development setup

After cloning the repository, install git hooks to ensure code quality:

make install-hooks

This installs a pre-commit hook that:

  • Automatically runs cargo fmt to format Rust code
  • Runs TypeScript linting/formatting checks (if applicable)
  • Aborts the commit if any files are changed by formatting

If the commit is aborted, review the formatting changes and re-commit:

git add -A
git commit

To temporarily bypass the hook (not recommended):

git commit --no-verify

Building the library

Build in development mode:

cargo build

Build optimized release version:

cargo build --release

Build with specific provider features:

cargo build --no-default-features --features="openai,anthropic"

Generating bindings

TypeScript bindings

TypeScript types for the universal Message format are automatically generated from Rust types using ts-rs:

# Generate TypeScript types from Rust
make generate-types

This creates TypeScript files in bindings/typescript/src/generated/:

  • Individual type files (e.g., Message.ts, UserContentPart.ts)
  • Automatic exports for all types marked with #[ts(export)]

Important: After modifying Rust types in src/universal/, always run make generate-types and commit the updated TypeScript files. CI will verify that generated types are up to date.

To build the full TypeScript bindings (WASM):

make typescript

Provider type generation

Generate provider-specific types from OpenAPI specs:

cargo run --bin generate-types openai
cargo run --bin generate-types anthropic

Testing

Run all tests (Rust, TypeScript, and Python):

make test

Run tests for specific languages:

make test-rust         # Rust tests only
make test-typescript   # TypeScript tests only
make test-python       # Python tests only

Run tests for specific features:

cargo test --features="openai"

Code quality

Format code:

make fmt              # Format all code (Rust + TypeScript)
cargo fmt             # Format Rust code only

Run linter:

cargo clippy --all-targets --all-features -- -D warnings

Check all code compiles:

make check            # Check Rust and TypeScript

Available features

  • openai - OpenAI API types and translators
  • anthropic - Anthropic API types and translators
  • google - Google Gemini API types and translators
  • bedrock - AWS Bedrock API types and translators

Default features: ["openai", "anthropic", "google", "bedrock"]