settings

Documentation

Index

• Variables
• func ReadFromEnv(prefix, field string) string
• func SettingsPath() string
• type Config
  • func (cfg *Config) Load() error
  • func (cfg *Config) LoadFromDisk() error
  • func (cfg *Config) LoadFromEnv(prefix string)
  • func (cfg *Config) ServerURL() (*url.URL, error)
  • func (cfg *Config) WithHTTPClient() error
  • func (cfg *Config) WriteToDisk() error
• type OrbPublishingInfo
• type TelemetrySettings
  • func (tel *TelemetrySettings) Load() error
  • func (tel *TelemetrySettings) Write() error
• type UpdateCheck
  • func (upd *UpdateCheck) Load() error
  • func (upd *UpdateCheck) WriteToDisk() error

Variables

var (
	FS afero.Afero = afero.Afero{
		Fs: afero.NewOsFs(),
	}
)

Functions

func ReadFromEnv

func ReadFromEnv(prefix, field string) string

ReadFromEnv takes a prefix and field to search the environment for after capitalizing and joining them with an underscore.

func SettingsPath

func SettingsPath() string

settingsPath returns the path of the CLI settings directory

Types

type Config

type Config struct {
	Host            string        `yaml:"host"`
	DlHost          string        `yaml:"-"`
	Endpoint        string        `yaml:"endpoint"`
	Token           string        `yaml:"token"`
	RestEndpoint    string        `yaml:"rest_endpoint"`
	TLSCert         string        `yaml:"tls_cert"`
	TLSInsecure     bool          `yaml:"tls_insecure"`
	HTTPClient      *http.Client  `yaml:"-"`
	Data            *data.DataBag `yaml:"-"`
	Debug           bool          `yaml:"-"`
	Address         string        `yaml:"-"`
	FileUsed        string        `yaml:"-"`
	GitHubAPI       string        `yaml:"-"`
	SkipUpdateCheck bool          `yaml:"-"`
	// Parameter used to disable telemetry from tests
	IsTelemetryDisabled bool `yaml:"-"`
	// If this value is defined, the telemetry will write all its events a file
	// The value of this field is the path where the telemetry will be written
	MockTelemetry string            `yaml:"-"`
	OrbPublishing OrbPublishingInfo `yaml:"orb_publishing"`
	TempDir       string            `yaml:"temp_dir,omitempty"`
}

Config is used to represent the current state of a CLI instance.

func (*Config) Load

func (cfg *Config) Load() error

Load will read the config from the user's disk and then evaluate possible configuration from the environment.

func (*Config) LoadFromDisk

func (cfg *Config) LoadFromDisk() error

LoadFromDisk is used to read config from the user's disk and deserialize the YAML into our runtime config.

func (*Config) LoadFromEnv

func (cfg *Config) LoadFromEnv(prefix string)

LoadFromEnv will read from environment variables of the given prefix for host, endpoint, and token specifically.

func (*Config) ServerURL

func (cfg *Config) ServerURL() (*url.URL, error)

ServerURL retrieves and formats a ServerURL from our restEndpoint and host.

func (*Config) WithHTTPClient

func (cfg *Config) WithHTTPClient() error

func (*Config) WriteToDisk

func (cfg *Config) WriteToDisk() error

WriteToDisk will write the runtime config instance to disk by serializing the YAML

type OrbPublishingInfo

type OrbPublishingInfo struct {
	DefaultNamespace   string `yaml:"default_namespace"`
	DefaultVcsProvider string `yaml:"default_vcs_provider"`
	DefaultOwner       string `yaml:"default_owner"`
}

type TelemetrySettings

type TelemetrySettings struct {
	IsEnabled         bool   `yaml:"is_enabled"`
	HasAnsweredPrompt bool   `yaml:"has_answered_prompt"`
	UniqueID          string `yaml:"unique_id"`
	UserID            string `yaml:"user_id"`
}

TelemetrySettings is used to represent telemetry related settings

func (*TelemetrySettings) Load

func (tel *TelemetrySettings) Load() error

Load will read the telemetry settings from the user's disk and then deserialize it into the current instance.

func (*TelemetrySettings) Write

func (tel *TelemetrySettings) Write() error

WriteToDisk will write the telemetry settings to disk by serializing the YAML

type UpdateCheck

type UpdateCheck struct {
	LastUpdateCheck time.Time `yaml:"last_update_check"`
	FileUsed        string    `yaml:"-"`
}

UpdateCheck is used to represent settings for checking for updates of the CLI.

func (*UpdateCheck) Load

func (upd *UpdateCheck) Load() error

Load will read the update check settings from the user's disk and then deserialize it into the current instance.

func (*UpdateCheck) WriteToDisk

func (upd *UpdateCheck) WriteToDisk() error

WriteToDisk will write the last update check to disk by serializing the YAML