moduleconfig

Documentation

Index

• type ModuleConfig
  • func LoadModuleConfig(dir string) (ModuleConfig, error)
  • func (c ModuleConfig) AbsDeployDir() string
• type ModuleGoConfig
• type ModuleKotlinConfig

Types

type ModuleConfig

type ModuleConfig struct {
	// Dir is the root of the module.
	Dir string `toml:"-"`

	Language string `toml:"language"`
	Realm    string `toml:"realm"`
	Module   string `toml:"module"`
	// Build is the command to build the module.
	Build string `toml:"build"`
	// Deploy is the list of files to deploy relative to the DeployDir.
	Deploy []string `toml:"deploy"`
	// DeployDir is the directory to deploy from, relative to the module directory.
	DeployDir string `toml:"deploy-dir"`
	// Schema is the name of the schema file relative to the DeployDir.
	Schema string `toml:"schema"`
	// Errors is the name of the error file relative to the DeployDir.
	Errors string `toml:"errors"`
	// Watch is the list of files to watch for changes.
	Watch []string `toml:"watch"`

	Go     ModuleGoConfig     `toml:"go,optional"`
	Kotlin ModuleKotlinConfig `toml:"kotlin,optional"`
}

ModuleConfig is the configuration for an FTL module.

Module config files are currently TOML.

func LoadModuleConfig

func LoadModuleConfig(dir string) (ModuleConfig, error)

LoadModuleConfig from a directory.

func (ModuleConfig) AbsDeployDir

func (c ModuleConfig) AbsDeployDir() string

AbsDeployDir returns the absolute path to the deploy directory.

type ModuleGoConfig

type ModuleGoConfig struct{}

ModuleGoConfig is language-specific configuration for Go modules.

type ModuleKotlinConfig

type ModuleKotlinConfig struct{}

ModuleKotlinConfig is language-specific configuration for Kotlin modules.