config

Documentation

Index

• type Config
  • func New() Config
  • func (config *Config) Exists(basePath string) bool
  • func (config *Config) GetPath(basePath string, fileNames []FileName) (string, *FileName, error)
  • func (config *Config) Read(configPath string, fileType FileType, out interface{}) error
  • func (config *Config) SetFS(fs afero.Fs)
• type FileName
  • func GetProjectFileNames() []FileName
  • func GetUserFileNames() []FileName
• type FileType

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

func New

func New() Config

func (*Config) Exists

func (config *Config) Exists(basePath string) bool

func (*Config) GetPath

func (config *Config) GetPath(basePath string, fileNames []FileName) (string, *FileName, error)

func (*Config) Read

func (config *Config) Read(configPath string, fileType FileType, out interface{}) error

Read Configuration file

func (*Config) SetFS

func (config *Config) SetFS(fs afero.Fs)

type FileName

type FileName struct {
	FileName string
	Type     FileType
}

func GetProjectFileNames

func GetProjectFileNames() []FileName

GetProjectFileNames represents project-specific configuration file names

func GetUserFileNames

func GetUserFileNames() []FileName

GetUserFileNames represents developer and project-specific configuration file names

type FileType

type FileType int64

const (
	YAML FileType = iota
	JSON
)