compiler

Documentation

Overview

Package compiler is the entrypoint to Joy's compiler It follows the steps outlined in: https://mat.tm/joy/#how

Index

• func Assemble(idx *index.Index, g *graph.Graph) (scripts []*script.Script, err error)
• func Compile(cfg *Config) (scripts []*script.Script, err error)
• func Parse(cfg *Config) (idx *index.Index, g *graph.Graph, err error)
• func Setup(cfg *Config) error
• func Watch(packages ...string)
• type Config

Functions

func Assemble

func Assemble(idx *index.Index, g *graph.Graph) (scripts []*script.Script, err error)

Assemble the code

func Compile

func Compile(cfg *Config) (scripts []*script.Script, err error)

Compile our Go application into a Javascript application

func Parse

func Parse(cfg *Config) (idx *index.Index, g *graph.Graph, err error)

Parse loads, indexes and graphs the program

This is breaking down our program into all the pieces we need to build it back up as a Javascript program.

Eventually, we'll be able use this stage separately from assembling to incrementally compile packages

func Setup

func Setup(cfg *Config) error

Setup the compiler's stdlib, runtime and macro source code we're going to keep this stupid simple right now

func Watch

func Watch(packages ...string)

Watch a set of packages

Types

type Config

type Config struct {
	// build a development or production bundle
	Development bool

	// path to runtime code (e.g. for channel support)
	RuntimePath string `valid:"required"`

	// path to the macro library
	MacroPath string `valid:"required"`

	// path to joy's stdlib
	StdPath string `valid:"required"`

	// packages to compile
	Packages []string
}

Config for the compiler