Welcome to the internal documentation for the HULK language implementation. This documentation is intended for maintainers and contributors.
HULK is a dual-component project designed to demonstrate the full compiler pipeline:
- HULK Frontend: A Python-based implementation that handles source code analysis and lowering to an intermediate representation.
- Banner IR: A Rust-based backend that executes the intermediate representation in a stack-based virtual machine.
- Literate Programming: The source code and the pedagogical book are one and the same.
- Single Source of Truth: Syntax highlighting definitions for VS Code and Quarto are generated from a single YAML specification.
- Modern Tooling: We leverage
uvfor Python dependency management andcargofor Rust.
- Deployment & Setup: How to build and run the project from scratch.
- Architectural Design: Deep dive into the project's structure and data flow.
- Development Workflow: Coding standards, testing strategies, and CI/CD integration.