config

package

v1.2.3 Latest Latest Go to latest Published: Mar 19, 2023 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/SpatiumPortae/portal

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Init() error
func IsDefault(key string) bool
type Config
- func GetDefault() Config
- func (config Config) Map() map[string]any
- func (config Config) Yaml() []byte

Constants ¶

View Source

const (
	CONFIGS_DIR_NAME       = ".config"
	PORTAL_CONFIG_DIR_NAME = "portal"
	CONFIG_FILE_NAME       = "config"
	CONFIG_FILE_EXT        = "yml"

	StyleRich = "rich"
	StyleRaw  = "raw"
)

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init() error

Init initializes the viper config. `config.yml` is created in $HOME/.config/portal if not already existing. NOTE: The precedence levels of viper are the following: flags -> config file -> defaults.

func IsDefault ¶

func IsDefault(key string) bool

Types ¶

type Config ¶

type Config struct {
	Relay                string `mapstructure:"relay"`
	Verbose              bool   `mapstructure:"verbose"`
	PromptOverwriteFiles bool   `mapstructure:"prompt_overwrite_files"`
	RelayServePort       int    `mapstructure:"relay_serve_port"`
	TuiStyle             string `mapstructure:"tui_style"`
}

func GetDefault ¶

func GetDefault() Config

func (Config) Map ¶

func (config Config) Map() map[string]any

func (Config) Yaml ¶

func (config Config) Yaml() []byte

Source Files ¶

View all Source files

config.go

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