projectconfig

Documentation

Index

• func DefaultConfigPath() optional.Option[string]
• func MaybeCreateDefault(ctx context.Context) error
• func Save(config Config) error
• type Commands
• type Config
  • func Load(ctx context.Context, path string) (Config, error)
  • func LoadOrCreate(ctx context.Context, target string) (Config, error)
  • func (c Config) AbsModuleDirs() []string
  • func (c Config) Root() string
• type ConfigAndSecrets
• type URL
  • func MustParseURL(rawurl string) *URL
  • func ParseURL(rawurl string) (*URL, error)
  • func (u URL) GoString() string
  • func (u URL) MarshalText() ([]byte, error)
  • func (u *URL) UnmarshalText(text []byte) error

Functions

func DefaultConfigPath

func DefaultConfigPath() optional.Option[string]

DefaultConfigPath returns the absolute default path for the project config file, if possible.

The default path is determined by the FTL_CONFIG environment variable, if set, or by the presence of a Git repository. If the Git repository is found, the default path is the root of the repository with the filename "ftl-project.toml".

func MaybeCreateDefault

func MaybeCreateDefault(ctx context.Context) error

MaybeCreateDefault creates the ftl-project.toml file in the Git root if it does not already exist.

func Save

func Save(config Config) error

Save project config to its file atomically.

Types

type Commands

type Commands struct {
	Startup []string `toml:"startup"`
}

type Config

type Config struct {
	// Path to the config file.
	Path string `toml:"-"`

	Global        ConfigAndSecrets            `toml:"global"`
	Modules       map[string]ConfigAndSecrets `toml:"modules"`
	ModuleDirs    []string                    `toml:"module-dirs"`
	ExternalDirs  []string                    `toml:"external-dirs"`
	Commands      Commands                    `toml:"commands"`
	FTLMinVersion string                      `toml:"ftl-min-version"`
}

func Load

func Load(ctx context.Context, path string) (Config, error)

Load project config from a file.

func LoadOrCreate

func LoadOrCreate(ctx context.Context, target string) (Config, error)

LoadOrCreate loads or creates the given configuration file.

func (Config) AbsModuleDirs

func (c Config) AbsModuleDirs() []string

AbsModuleDirs returns the absolute path for the module-dirs field from the ftl-project.toml, unless that is not defined, in which case it defaults to the root directory.

func (Config) Root

func (c Config) Root() string

Root directory of the project.

type ConfigAndSecrets

type ConfigAndSecrets struct {
	Config  map[string]*URL `toml:"configuration"`
	Secrets map[string]*URL `toml:"secrets"`
}

type URL

type URL url.URL

A URL that supports marshalling and unmarshalling which is, very frustratingly, not possible with the stdlib url.URL.

func MustParseURL

func MustParseURL(rawurl string) *URL

func ParseURL

func ParseURL(rawurl string) (*URL, error)

func (URL) GoString

func (u URL) GoString() string

func (URL) MarshalText

func (u URL) MarshalText() ([]byte, error)

func (*URL) UnmarshalText

func (u *URL) UnmarshalText(text []byte) error