config

Documentation

Index

• Constants
• func GetConfigFilePath() string
• func PrintSection(section interface{ ... }, format Format, w io.Writer) (err error)
• func PrintSettings(settings Settings, format Format, w io.Writer) (err error)
• type ClientConfig
• type Format
• type ProjectConfig
  • func (v ProjectConfig) Validate() error
• type ServerConfig
• type Settings
  • func GetSettings() (settings Settings, err error)
  • func (v Settings) GetProjectConfig(projectID string) *ProjectConfig
• type StoreType
• type UrlConfig
  • func (v *UrlConfig) IsEmpty() bool

Constants

const (
	DefaultHost       = "localhost"
	DefaultClientPort = 4200
	DefaultServerPort = 8989
)

const ConfigFileName = ".datatug.yaml"

const FileStoreUrlPrefix = "file:"

Functions

func GetConfigFilePath

func GetConfigFilePath() string

func PrintSection

func PrintSection(section interface{ IsEmpty() bool }, format Format, w io.Writer) (err error)

func PrintSettings

func PrintSettings(settings Settings, format Format, w io.Writer) (err error)

Types

type ClientConfig

type ClientConfig struct {
	UrlConfig `yaml:",inline"`
}

type Format

type Format string

const (
	FormatYaml Format = "yaml"
)

type ProjectConfig

type ProjectConfig struct {
	ID    string `yaml:"-"`
	Url   string `yaml:"url"`
	Title string `yaml:"title,omitempty"`
}

ProjectConfig hold project configuration, specifically path to project directory

func (ProjectConfig) Validate

func (v ProjectConfig) Validate() error

type ServerConfig

type ServerConfig struct {
	UrlConfig `yaml:",inline"`
}

type Settings

type Settings struct {
	Projects []*ProjectConfig `yaml:"projects,omitempty"` // Intentionally do not use map
	Client   *ClientConfig    `yaml:"client,omitempty"`
	Server   *ServerConfig    `yaml:"server,omitempty"`
}

Settings hold DataTug executable configuration for commands like `serve`

func GetSettings

func GetSettings() (settings Settings, err error)

func (Settings) GetProjectConfig

func (v Settings) GetProjectConfig(projectID string) *ProjectConfig

type StoreType

type StoreType string

type UrlConfig

type UrlConfig struct {
	Host string `yaml:"host,omitempty"`
	Port int    `yaml:"port,omitempty"`
}

UrlConfig holds host name and port

func (*UrlConfig) IsEmpty

func (v *UrlConfig) IsEmpty() bool