internal

Documentation

Overview

Package internal manages the persistent profile configuration of the FTL CLI.

Layout will be something like:

.ftl-project/
	project.json
	profiles/
		<profile>/
			profile.json
			[secrets.json]
			[config.json]

See the design document for more information.

Index

• func Init(project Project) error
• type Profile
  • func (p *Profile) EndpointURL() (*url.URL, error)
• type ProfileType
• type Project
  • func Load(root string) (Project, error)
  • func (p Project) ActiveProfile() (string, error)
  • func (p Project) ListProfiles() ([]Profile, error)
  • func (p Project) LoadProfile(name string) (Profile, error)
  • func (p Project) LocalConfigPath(profile string) string
  • func (p Project) LocalSecretsPath(profile string) string
  • func (p Project) Save() error
  • func (p Project) SaveProfile(profile Profile) error
  • func (p Project) SetActiveProfile(profile string) error

Functions

func Init

func Init(project Project) error

Types

type Profile

type Profile struct {
	Name            string                    `json:"name"`
	Endpoint        string                    `json:"endpoint"`
	Type            ProfileType               `json:"type"`
	SecretsProvider configuration.ProviderKey `json:"secrets-provider"`
	ConfigProvider  configuration.ProviderKey `json:"config-provider"`
}

func (*Profile) EndpointURL

func (p *Profile) EndpointURL() (*url.URL, error)

type ProfileType

type ProfileType string

const (
	ProfileTypeLocal  ProfileType = "local"
	ProfileTypeRemote ProfileType = "remote"
)

type Project

type Project struct {
	Realm          string   `json:"realm"`
	FTLMinVersion  string   `json:"ftl-min-version,omitempty"`
	ModuleRoots    []string `json:"module-roots,omitempty"`
	Git            bool     `json:"git,omitempty"`
	Hermit         bool     `json:"hermit,omitempty"`
	DefaultProfile string   `json:"default-profile,omitempty"`

	Root string `json:"-"`
}

func Load

func Load(root string) (Project, error)

Load the project configuration from the given root directory.

func (Project) ActiveProfile

func (p Project) ActiveProfile() (string, error)

ActiveProfile returns the name of the active profile.

If no profile is active, it returns the default.

func (Project) ListProfiles

func (p Project) ListProfiles() ([]Profile, error)

ListProfiles returns the names of all profiles in the project.

func (Project) LoadProfile

func (p Project) LoadProfile(name string) (Profile, error)

func (Project) LocalConfigPath

func (p Project) LocalConfigPath(profile string) string

LocalConfigPath returns the path to the config file for the given local profile.

func (Project) LocalSecretsPath

func (p Project) LocalSecretsPath(profile string) string

LocalSecretsPath returns the path to the secrets file for the given local profile.

func (Project) Save

func (p Project) Save() error

func (Project) SaveProfile

func (p Project) SaveProfile(profile Profile) error

SaveProfile saves a profile to the project.

func (Project) SetActiveProfile

func (p Project) SetActiveProfile(profile string) error