config

README

CONFIG

Package config provides a simple facility for loading configuration file.

Feature

• Very simple to use.
• Easily obtain the execution directory and home directory.

Dependencies

• go 1.20+

Usage

import "gitee.com/erdian718/config"

// Config represents the configuration information.
type Config struct {
	// ...
}

func main() {
	cfg := Config{
		// The default values...
	}

	if err := config.Load(&cfg, "path", "to", "configuration", "file.json"); err != nil {
		panic(err)
	}

	// ...
}

Note

• Only support JSON and XML files.
• Only support UTF-8 and UTF-8 with BOM.

Documentation

Overview

Package config provides a simple facility for loading configuration file.

Example

package main

import (
	"fmt"

	"gitee.com/erdian718/config"
)

// Config represents the configuration information.
type Config struct {
	Default string
	Value   string
}

func main() {
	cfg := Config{
		Default: "default", // The default value.
	}

	if err := config.Load(&cfg, config.ExecDir(), "config.json"); err != nil {
		panic(err)
	}

	fmt.Println(cfg.Default)
	fmt.Println(cfg.Value)
}

Output:

default
value

Index

• func ExecDir() string
• func HomeDir() string
• func Load(cfg any, elems ...string) error

Examples

• Package

Functions

func ExecDir

func ExecDir() string

ExecDir returns the directory of the executable that started the current process. This function is goroutine safe.

func HomeDir

func HomeDir() string

HomeDir returns the current user's home directory. This function is goroutine safe.

func Load

func Load(cfg any, elems ...string) error

Load loads configuration from file.