projectconfig

Documentation

Index

• func ConfigPaths(input []string) []string
• func Save(path string, config Config) error
• type Config
  • func LoadConfig(ctx context.Context, input []string) (Config, error)
  • func LoadWritableConfig(ctx context.Context, input []string) (Config, error)
  • func Merge(paths ...string) (Config, error)
• 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 ConfigPaths

func ConfigPaths(input []string) []string

ConfigPaths returns the computed list of configuration paths to load.

func Save

func Save(path string, config Config) error

Save project config atomically to a file.

Types

type Config

type Config struct {
	Global       ConfigAndSecrets            `toml:"global"`
	Modules      map[string]ConfigAndSecrets `toml:"modules"`
	ModuleDirs   []string                    `toml:"module-dirs"`
	ExternalDirs []string                    `toml:"external-dirs"`
}

func LoadConfig

func LoadConfig(ctx context.Context, input []string) (Config, error)

func LoadWritableConfig

func LoadWritableConfig(ctx context.Context, input []string) (Config, error)

LoadWritableConfig loads the last config file in the list of paths, or an empty config if none are found.

func Merge

func Merge(paths ...string) (Config, error)

Merge configuration files.

Config is merged left to right, with later files taking precedence over earlier files.

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