package
0.0.0-20241123081934-5b2a99bd3a3f
Repository: https://github.com/nextpkg/nextcfg.git
Documentation: pkg.go.dev

# README

File Source

The file s reads config from a file.

It uses the File extension to determine the Format e.g config.yaml has the yaml format. It does not make use of encoders or interpet the file data. If a file extension is not present the s Format will default to the Encoder in options.

Example

A config file format in json

{
    "hosts": {
        "database": {
            "address": "10.0.0.1",
            "port": 3306
        },
        "cache": {
            "address": "10.0.0.2",
            "port": 6379
        }
    }
}

New Source

Specify file s with path to file. Path is optional and will default to config.json

fileSource := file.NewSource(
	file.WithPath("/tmp/config.json"),
)

File Format

To load different file formats e.g yaml, toml, xml simply specify them with their extension

fileSource := file.NewSource(
        file.WithPath("/tmp/config.yaml"),
)

If you want to specify a file without extension, ensure you set the encoder to the same format

e := toml.NewEncoder()

fileSource := file.NewSource(
        file.WithPath("/tmp/config"),
	s.WithEncoder(e),
)

Load Source

Load the s into config

// Create new config
conf := nextcfg.NewConfig()

// Load file s
conf.Load(fileSource)

# Functions

GetLoader sets file source.
LoadFile is shorthand for creating a file source and loading it.
NewSource 文件数据源.
WithPath sets the path to file.

# Variables

DefaultPath 默认文件名.