config

Documentation

Index

• Constants
• func CachePath() (string, error)
• func EnsureDirectory(dir string, err error) (string, error)
• func PackageCachePaths() ([]string, error)
• func PackageInstallPath() (string, bool)
• func RegistryCachePaths() ([]string, error)
• func UserConfigFile() (string, bool)
• func UserConfigPath() (string, error)

Constants

const (

	// ToitPackageCachePathsEnv contains the paths where the compiler is looking for cached packages.
	// This constant must be kept in sync with the one in the compiler.
	ToitPackageCachePathsEnv = "TOIT_PACKAGE_CACHE_PATHS"
	// ToitRegistryCachePathsEnv contains the paths where the compiler is looking for cached registries.
	ToitRegistryCachePathsEnv = "TOIT_REGISTRY_CACHE_PATHS"
	// ToitRegistryInstallPathEnv contains the paths where tpkg will install packages for the project.
	ToitRegistryInstallPathEnv = "TOIT_PACKAGE_INSTALL_PATH"
	// UserConfigDirEnv if set, will be the directory the user config will be loaded from.
	UserConfigDirEnv = "TOIT_USER_CONFIG_DIR"
)

Functions

func CachePath

func CachePath() (string, error)

func EnsureDirectory

func EnsureDirectory(dir string, err error) (string, error)

func PackageCachePaths

func PackageCachePaths() ([]string, error)

PackageCachePaths returns the paths where the compiler is looking for cached packages.

func PackageInstallPath

func PackageInstallPath() (string, bool)

func RegistryCachePaths

func RegistryCachePaths() ([]string, error)

RegistryCachePaths returns the paths where the compiler is looking for cached registries.

func UserConfigFile

func UserConfigFile() (string, bool)

UserConfigFile returns the config file in the user directory.

func UserConfigPath

func UserConfigPath() (string, error)