config

Documentation

Index

• Constants
• func GlobalConfigFileAbsolutePath() (string, error)
• func LocalConfigDirectoryAbsolutePath() (string, error)
• func UnmarshalGlobalConfig(v interface{}) error
• func UnmarshalLocalConfig(v interface{}) error
• type ErrKeyInvalid
  • func (err *ErrKeyInvalid) Error() string
• type ErrKeyNotSet
  • func (err *ErrKeyNotSet) Error() string

Constants

const (
	// LocalConfigDirname is the directory relative to the repository root
	// that is being used to store all SalsaFlow-related files.
	LocalConfigDirname = ".salsaflow"

	// LocalConfigFilename is the filename of the configuration file
	// that represents local project-specific SalsaFlow configuration.
	//
	// This file is expected to be placed in the repository root.
	LocalConfigFilename = "config.yml"

	// GlobalConfigFilename is the filename of the configuration file
	// that represents global user-specific SalsaFlow configuration.
	//
	// This file is expected to be placed in the user's home directory.
	GlobalConfigFilename = ".salsaflow.yml"
)

Functions

func GlobalConfigFileAbsolutePath

func GlobalConfigFileAbsolutePath() (string, error)

func LocalConfigDirectoryAbsolutePath

func LocalConfigDirectoryAbsolutePath() (string, error)

func UnmarshalGlobalConfig

func UnmarshalGlobalConfig(v interface{}) error

func UnmarshalLocalConfig

func UnmarshalLocalConfig(v interface{}) error

Types

type ErrKeyInvalid

type ErrKeyInvalid struct {
	Key   string
	Value interface{}
}

func (*ErrKeyInvalid) Error

func (err *ErrKeyInvalid) Error() string

type ErrKeyNotSet

type ErrKeyNotSet struct {
	Key string
}

func (*ErrKeyNotSet) Error

func (err *ErrKeyNotSet) Error() string