cfg

package

v0.37.0 Latest Latest Go to latest Published: Feb 26, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/apigear-io/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AllSettings() map[string]interface{}
func AppendRecentEntry(value string) error
func CacheDir() string
func ConfigDir() string
func ConfigFileUsed() string
func EditorCommand() string
func Get(key string) any
func GetBool(key string) bool
func GetInt(key string) int
func GetString(key string) string
func IsSet(key string) bool
func NewConfig(cfgDir string) (*viper.Viper, error)
func RecentEntries() []string
func RegistryCachePath() string
func RegistryDir() string
func RegistryUrl() string
func RemoveRecentEntry(value string) error
func ServerPort() string
func Set(key string, value any)
func SetBool(key string, value bool)
func SetBuildInfo(name string, info BuildInfo)
func SetConfig(c *viper.Viper)
func UpdateChannel() string
func WriteConfig() error
type BuildInfo
- func GetBuildInfo(name string) BuildInfo

Constants ¶

View Source

const (
	KeyRecent        = "recent"
	KeyServerPort    = "server_port"
	KeyEditorCommand = "editor_command"
	KeyUpdateChannel = "update_channel"
	KeyCacheDir      = "templates_dir"
	KeyRegistryDir   = "registry_dir"
	KeyRegistryUrl   = "registry_url"
	KeyVersion       = "version"
	KeyCommit        = "commit"
	KeyDate          = "date"
	KeyWindowHeight  = "window_height"
	KeyWindowWidth   = "window_width"
)

Variables ¶

This section is empty.

Functions ¶

func AllSettings ¶

func AllSettings() map[string]interface{}

func AppendRecentEntry ¶

func AppendRecentEntry(value string) error

AppendRecentEntry appends a new entry to the list of recent entries entries are limited to 5 the most recent entry is at the beginning of the list stores the list in the config file

func CacheDir ¶ added in v0.29.0

func CacheDir() string

func ConfigDir ¶

func ConfigDir() string

func ConfigFileUsed ¶

func ConfigFileUsed() string

func EditorCommand ¶

func EditorCommand() string

func Get ¶

func Get(key string) any

func GetBool ¶ added in v0.31.5

func GetBool(key string) bool

func GetInt ¶ added in v0.31.6

func GetInt(key string) int

func GetString ¶

func GetString(key string) string

func IsSet ¶

func IsSet(key string) bool

func NewConfig ¶

func NewConfig(cfgDir string) (*viper.Viper, error)

func RecentEntries ¶

func RecentEntries() []string

RecentEntries returns the list of recent entries

func RegistryCachePath ¶

func RegistryCachePath() string

func RegistryDir ¶

func RegistryDir() string

func RegistryUrl ¶

func RegistryUrl() string

func RemoveRecentEntry ¶

func RemoveRecentEntry(value string) error

RemoveRecentEntry removes a recent entry from the list

func ServerPort ¶

func ServerPort() string

func Set ¶

func Set(key string, value any)

func SetBool ¶ added in v0.31.5

func SetBool(key string, value bool)

func SetBuildInfo ¶

func SetBuildInfo(name string, info BuildInfo)

func SetConfig ¶

func SetConfig(c *viper.Viper)

func UpdateChannel ¶

func UpdateChannel() string

func WriteConfig ¶

func WriteConfig() error

Types ¶

type BuildInfo ¶ added in v0.35.0

type BuildInfo struct {
	Version string `yaml:"version"`
	Commit  string `yaml:"commit"`
	Date    string `yaml:"date"`
}

BuildInfo contains information about the build it is stored under a key named "build" in the config file with the name (e.g. cli, studio) as sub-key

func GetBuildInfo ¶ added in v0.35.0

func GetBuildInfo(name string) BuildInfo

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL