Primeiros passos

Clonar o repositório

git clone -c core.longpaths=true git@github.com:oxc-project/oxc.git

Configurar o projeto

Instalar Rust

Se ainda não tiver instalado o Rust, siga as instruções oficiais.

Depois da instalação, na raiz do projeto execute:

rustup show

O rustup show lê o arquivo ./rust-toolchain.toml e instala a cadeia de ferramentas Rust e os componentes corretos para este projeto.

cargo binstall

Algumas ferramentas Cargo são necessárias para desenvolver o OXC; recomenda-se cargo binstall, que oferece uma forma simples de instalar binários Rust e costuma ser mais rápido que compilar tudo com cargo install.

cargo install cargo-binstall

Também é possível baixar o binário pré-compilado e colocá-lo em ~/.cargo/bin.

just

O OXC usa just, uma forma prática de guardar e rodar comandos específicos do projeto:

cargo binstall just -y

Instalar CMake

Instale o CMake pelo site oficial.

Quem usa Homebrew pode instalar assim:

brew install cmake

Instalar pnpm

Instale o pnpm (gerenciador de pacotes Node.js, semelhante ao npm) seguindo o site oficial.

Dependências

Na raiz do projeto, use o justfile para instalar dependências:

just init

A lista de comandos disponíveis aparece com just.

Execute just ready (ou just r) para garantir que o projeto inteiro compila e roda corretamente.

macOS: compilação mais rápida

O macOS tem o XProtect, que analisa executáveis em busca de malware na primeira execução. Isso pode deixar os builds Rust bem mais lentos, em especial scripts de build e binários de teste. Dá para acelerar marcando o Terminal como “ferramenta de desenvolvimento” nas Configurações:

1. Configurações do Sistema > Privacidade e segurança > Ferramentas de desenvolvedor
2. Adicione o app de terminal (Terminal, iTerm etc.)
3. Reinicie o terminal

Observação: isso reduz uma camada de segurança do SO. Só faça se aceitar o trade-off.

Mais detalhes: https://nnethercote.github.io/2025/09/04/faster-rust-builds-on-mac.html