conf

package

v1.9.2 Latest Latest Go to latest Published: Nov 19, 2024 License: MIT Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/yeqown/gitlab-flow

Links

Open Source Insights

Documentation ¶

Overview ¶

Package conf implements the configuration of the application. The configuration is loaded from the configuration file. The configuration file is a TOML file.

Example (Save) ¶

Output:

Index ¶

Constants
func ConfigPath(parent string) string
func Default() *types.Config
func Load(confPath string, parser Parser, must bool) (cfg *types.Config, err error)
func Save(confPath string, cfg *types.Config, global bool) error
type Parser
- func NewTOMLParser() Parser

Examples ¶

Package (Save)

Constants ¶

View Source

const (
	DefaultScopes       = "api read_user read_repository"
	DefaultCallbackHost = "localhost:2333"
)

Variables ¶

This section is empty.

Functions ¶

func ConfigPath ¶ added in v1.9.1

func ConfigPath(parent string) string

func Default ¶

func Default() *types.Config

Default get default config which is embedded in the source file, so that this program could run without any configuration file.

func Load ¶

func Load(confPath string, parser Parser, must bool) (cfg *types.Config, err error)

Load to load config from confPath with specified parser.

func Save ¶

func Save(confPath string, cfg *types.Config, global bool) error

Types ¶

type Parser ¶ added in v1.8.0

type Parser interface {
	// Unmarshal ...
	Unmarshal(r io.Reader, rcv *types.Config) error

	// Marshal ...
	Marshal(cfg *types.Config) ([]byte, error)
}

Parser is an interface to parse config in different ways. For example: JSON, TOML and YAML;

func NewTOMLParser ¶

func NewTOMLParser() Parser

Source Files ¶

View all Source files

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