compile

Documentation

Overview

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

Index

• func Build(ctx context.Context, projectRootDir, moduleDir string, sch *schema.Schema, ...) (err error)
• func CleanStubs(ctx context.Context, projectRoot string) error
• func ExtractModuleSchema(dir string, sch *schema.Schema) (extract.Result, error)
• func GenerateStubsForModules(ctx context.Context, projectRoot string, ...) error
• func SyncGeneratedStubReferences(ctx context.Context, projectRootDir string, stubbedModules []string, ...) error
• type ExternalModuleContext
• type MainWorkContext
• type ModifyFilesTransaction
• type NativeNames

Functions

func Build

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

Build the given module.

func CleanStubs

func CleanStubs(ctx context.Context, projectRoot string) error

CleanStubs removes all generated stubs.

func ExtractModuleSchema

func ExtractModuleSchema(dir string, sch *schema.Schema) (extract.Result, error)

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

TODO: once migrated off of the legacy extractor, we can inline `extract.Extract(dir)` and delete this function

func GenerateStubsForModules

func GenerateStubsForModules(ctx context.Context, projectRoot string, moduleConfigs []moduleconfig.ModuleConfig, sch *schema.Schema) error

GenerateStubsForModules generates stubs for all modules in the schema.

func SyncGeneratedStubReferences

func SyncGeneratedStubReferences(ctx context.Context, projectRootDir string, stubbedModules []string, moduleConfigs []moduleconfig.ModuleConfig) error

Types

type ExternalModuleContext

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

type MainWorkContext

type MainWorkContext struct {
	GoVersion          string
	SharedModulesPaths []string
}

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.