Configuration file syntax and parsing for golang
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Brett Langdon 705dccdc29 fix package comment 11 years ago
config add SectionValue.Resolve 11 years ago
example have main api return back config.SectionValue 11 years ago
parser add SectionValue.Resolve 11 years ago
token add include directive 11 years ago
LICENSE Add license 11 years ago
README.md some more documentation is good 11 years ago
example_test.go some more documentation is good 11 years ago
forge.go fix package comment 11 years ago

README.md

forge

GoDoc

Forge is a configuration syntax and parser.

Installation

git get github.com/brettlangdon/forge

Documentation

Documentation can be viewed on godoc: https://godoc.org/github.com/brettlangdon/forge

Example

You can see example usage in the example folder.

``cfg

example.cfg

Global directives

global = "global value";

Primary section

primary { string = "primary string value"; integer = 500; float = 80.80; boolean = true; negative = FALSE; nothing = NULL;

Include external files

include "./include*.cfg";

Primary-sub section

sub { key = "primary sub key value"; } }

Secondary section

secondary { another = "secondary another value"; global_reference = global; primary_sub_key = primary.sub.key; another_again = .another; # References secondary.another _under = 50; }


```go
package main

import (
	"fmt"
	"json"

	"github.com/brettlangdon/forge"
)

func main() {
	// Parse a `SectionValue` from `example.cfg`
	settings, err := forge.ParseFile("example.cfg")
	if err != nil {
		panic(err)
	}

	// Get a single value
	if settings.Contains("global") {
		// Get `global` casted as `StringValue`
		value := settings.GetString("global")
		fmt.Printf("global = \"%s\"\r\n", value.GetValue())
	}

	// Get a nested value
	value, err := settings.Resolve("primary.included_setting")
	fmt.Printf("primary.included_setting = \"%s\"\r\n", value.GetValue())

	// You can also traverse down the sections
	primary, err := settings.GetSection("primary")
	value, err := primary.GetString("included_setting")
	fmt.Printf("primary.included_setting = \"%s\"\r\n", value.GetValue())

	// Convert settings to a map
	settingsMap, err := settings.ToMap()
	fmt.Printf("global = \"%s\"\r\n", settingsMap["global"])

	// Convert settings to JSON
	jsonBytes, err := settings.ToJSON()
	fmt.Printf("\r\n\r\n%s\r\n", string(jsonBytes))
}

Issues/Requests?

Please feel free to open a github issue for any issues you have or any feature requests.