Expand description
Compiler for inkle’s ink narrative scripting language.
Orchestrates the full compilation pipeline: file discovery, parsing
(brink-syntax), HIR lowering (brink-ir), semantic analysis
(brink-analyzer), and codegen into the brink-format binary
representation consumed by brink-runtime.
Structs§
- Analysis
Options - Tooling options for analysis: the registered host manifest and the severity policy for its external checks. Defaults to no manifest.
- Compile
Output - Successful compilation output, including any non-fatal warnings.
- FileId
- Opaque identifier for a source file within a multi-file project.
- LirOutput
- Successful LIR compilation output, including any non-fatal warnings.
- Resolved
Diagnostic - A diagnostic resolved for consumption outside the compiler.
Enums§
- Compile
Error - Errors that can occur during compilation.
- Diagnostic
Code - Stable error codes for brink diagnostics.
Functions§
- compile
- Compile an ink story with caller-provided file reading.
- compile_
path - Compile an ink story from an entry-point file path.
- compile_
string_ to_ json - Compile ink source from a string to the ink.json format.
- compile_
to_ json - Compile an ink story to the ink.json format (same as inklecate output).
- compile_
with_ options - Compile with explicit analysis options — e.g. a registered host-capability manifest and external-check severity (the “compiler flag, error by default”). Manifest-driven diagnostics are surfaced as compile warnings or errors per the severity policy.