Development Setup

This guide is for developers who want to modify the Matador compiler, interpreter, or documentation.

Repository Architecture

Matador is a monorepo containing three distinct subsystems.

graph TD
    Root[Monorepo Root] --> Contracts[contracts/]
    Root --> DSL[dsl/]
    Root --> Docs[docs/]
    
    Contracts --> Foundry[Foundry Framework]
    Contracts --> Solidity[Interpreter & Modules]
    
    DSL --> Langium[Langium Framework]
    DSL --> Compiler[Compiler Core]
    DSL --> CLI[CLI Tool]
    DSL --> VSCode[VSCode Extension]
    
    Docs --> Next[Next.js App]
    Docs --> Content[MDX Content]

Prerequisites

Ensure you have the following installed before starting:

• Node.js: v20+ (Required for DSL and Docs)
• Foundry: Latest version (Required for Contracts)
• Git: For version control

Setup Instructions

git clone https://github.com/SteerFinance/matador.git
cd matador

cd contracts

# Install submodules (OpenZeppelin, etc.)
forge install

# Build contracts
forge build

# Run unit tests
forge test

cd dsl

# Install dependencies
npm install

# Generate Langium artifacts (parser, types)
npm run langium:generate

# Build all packages (core, cli, language)
npm run build

# Run test suite
npm run test

cd docs

# Install dependencies
npm install

# Start local dev server
npm run dev

IDE Configuration

We strongly recommend VS Code for Matador development.

Recommended Extensions

• Solidity (Nomic Foundation) - For contract syntax highlighting.
• ESLint / Prettier - For TypeScript code style.
• Matador Language - You can side-load the local extension from dsl/packages/extension to get live syntax highlighting for .matador files.

cd dsl/packages/cli
npm link