compile

Documentation

Overview

Package compile compiles FTL Go module source into a deployable executable.

Index

• func Build(ctx context.Context, moduleDir string, sch *schema.Schema, ...) (err error)
• func ExtractModuleSchema(dir string) (optional.Option[ParseResult], error)
• func GenerateStubsForExternalLibrary(ctx context.Context, dir string, schema *schema.Schema) error
• type ExternalModuleContext
  • func (b ExternalModuleContext) NonMainModules() []*schema.Module
• type ModifyFilesTransaction
• type NativeNames
• type ParseResult

Functions

func Build

func Build(ctx context.Context, moduleDir string, sch *schema.Schema, filesTransaction ModifyFilesTransaction) (err error)

Build the given module.

func ExtractModuleSchema

func ExtractModuleSchema(dir string) (optional.Option[ParseResult], error)

ExtractModuleSchema statically parses Go FTL module source into a schema.Module.

func GenerateStubsForExternalLibrary

func GenerateStubsForExternalLibrary(ctx context.Context, dir string, schema *schema.Schema) error

Types

type ExternalModuleContext

type ExternalModuleContext struct {
	ModuleDir string
	*schema.Schema
	GoVersion    string
	FTLVersion   string
	Main         string
	Replacements []*modfile.Replace
}

func (ExternalModuleContext) NonMainModules

func (b ExternalModuleContext) NonMainModules() []*schema.Module

type ModifyFilesTransaction

type ModifyFilesTransaction interface {
	Begin() error
	ModifiedFiles(paths ...string) error
	End() error
}

type NativeNames

type NativeNames map[schema.Node]string

NativeNames is a map of top-level declarations to their native Go names.

type ParseResult

type ParseResult struct {
	Module      *schema.Module
	NativeNames NativeNames
	// EnumRefs contains any external enums referenced by this module. The refs will be resolved and any type enums
	// will be registered to the `ftl.TypeRegistry` and provided in the context for this module.
	EnumRefs []*schema.Ref
	// Errors contains schema validation errors encountered during parsing.
	Errors []*schema.Error
}