jconf

README

jconf - simple Go package to read/write JSON/YAML config file

Functions

• Write() - write JSON/YAML config file
• Read() - read JSON/YAML config file
• Show() - show structure to stdout as JSON
• ShowYAML() - show structure to stdout as YAML

Documentation

Overview

jconf - simple Go package to read/write JSON config file

Functions:

Read() - read JSON config file

Write() - write JSON config file

Show() - show JSON config structure to stdout

Index

• Constants
• Variables
• func IsYAML(fileName string) bool
• func Read(conf any, fileName string) error
• func Show(conf any) error
• func ShowYAML(conf any) error
• func ToYAML(conf any) (string, error)
• func Write(conf any, fileName string) error

Constants

const FILE_MODE = 0640

Default config file mode

Variables

var YAML_EXTS = []string{
	".yaml", ".YAML",
	".yml", ".YML",
	".yconf", ".YCONF",
	".yml.conf", ".YML.CONF",
}

YAML config file extensions (suffixes)

Functions

func IsYAML

func IsYAML(fileName string) bool

Check file name is YAML

func Read

func Read(conf any, fileName string) error

Read JSON config file

func Show

func Show(conf any) error

Show structure to stdout as JSON

func ShowYAML

func ShowYAML(conf any) error

Show structure to stdout as YAML

func ToYAML

func ToYAML(conf any) (string, error)

Marshal YAML

func Write

func Write(conf any, fileName string) error

Write JSON/YAML config file