config

Documentation

Index

• Constants
• Variables
• type Cache
• type CacheDuration
  • func (d CacheDuration) MarshalYAML() (interface{}, error)
  • func (d CacheDuration) String() string
  • func (d *CacheDuration) UnmarshalYAML(node *yaml.Node) error
• type Config
  • func NewConfig(path string) (*Config, error)
  • func NewConfigWithPath(p string) (*Config, error)
  • func (c *Config) SaveConfig(path string) error
• type LegacyVersionFile
• type Proxy
• type Registry
• type Storage
  • func (s *Storage) Validate() error

Constants

const (
	LatestInstalledStrategy = "latest_installed"
	LatestAvailableStrategy = "latest_available"
	SpecifiedStrategy       = "specified"
	DefaultStrategy         = SpecifiedStrategy
)

Variables

var (
	DefaultConfig = &Config{
		Proxy:             EmptyProxy,
		Storage:           EmptyStorage,
		Registry:          EmptyRegistry,
		LegacyVersionFile: EmptyLegacyVersionFile,
		Cache:             EmptyCache,
	}
)

var (
	EmptyCache = &Cache{
		AvailableHookDuration: CacheDuration(12 * time.Hour),
	}
)

var EmptyLegacyVersionFile = &LegacyVersionFile{
	Enable:   true,
	Strategy: DefaultStrategy,
}

var (
	EmptyProxy = &Proxy{
		Url:    "",
		Enable: false,
	}
)

var EmptyRegistry = &Registry{
	Address: "",
}

var EmptyStorage = &Storage{
	SdkPath: "",
}

Types

type Cache

type Cache struct {
	AvailableHookDuration CacheDuration `yaml:"availableHookDuration"` // Available hook result cache time
}

Cache is the cache configuration

type CacheDuration

type CacheDuration time.Duration

CacheDuration is a duration that represents the cache duration and some special values -1: never expire 0: never cache

func (CacheDuration) MarshalYAML

func (d CacheDuration) MarshalYAML() (interface{}, error)

func (CacheDuration) String

func (d CacheDuration) String() string

func (*CacheDuration) UnmarshalYAML

func (d *CacheDuration) UnmarshalYAML(node *yaml.Node) error

type Config

type Config struct {
	Proxy             *Proxy             `yaml:"proxy"`
	Storage           *Storage           `yaml:"storage"`
	Registry          *Registry          `yaml:"registry"`
	LegacyVersionFile *LegacyVersionFile `yaml:"legacyVersionFile"`
	Cache             *Cache             `yaml:"cache"`
}

func NewConfig

func NewConfig(path string) (*Config, error)

func NewConfigWithPath

func NewConfigWithPath(p string) (*Config, error)

func (*Config) SaveConfig

func (c *Config) SaveConfig(path string) error

type LegacyVersionFile

type LegacyVersionFile struct {
	Enable bool `yaml:"enable"`
	// Support three strategies:
	// 1. latest_installed: use the latest installed version
	// 2. latest_available: use the latest available version
	// 3. specified: use the specified version in the legacy file
	// default: specified
	Strategy string `yaml:"strategy"`
}

LegacyVersionFile represents whether to enable the ability to parse legacy version files,

type Proxy

type Proxy struct {
	Url    string `yaml:"url"`
	Enable bool   `yaml:"enable"`
}

type Registry

type Registry struct {
	Address string `yaml:"address"`
}

type Storage

type Storage struct {
	SdkPath string `yaml:"sdkPath"`
}

func (*Storage) Validate

func (s *Storage) Validate() error