Google Git
Sign in
edge / third_party / pelletier / go-toml / 45932ad32dfdd20826f5671da37a5f3ce9f26a8d
commit45932ad32dfdd20826f5671da37a5f3ce9f26a8d[log] [tgz]
authorCameron Moore <moorereason@gmail.com>Tue Sep 20 02:07:15 2016 -0500
committerThomas Pelletier <pelletier.thomas@gmail.com>Tue Sep 20 09:07:15 2016 +0200
tree15393b5dd42bc30c0720b5330618c895987ee053
parent67b7b944a887e08e833aba866360b2d8ad87db69 [diff]
Handle nil, map[string]string, and map[interface{}]interface{} input (#103)

* Handle map[string]string and map[interface{}]interface{} input
* Handle nil values

Fixes #99
2 files changed
tree: 15393b5dd42bc30c0720b5330618c895987ee053
  1. cmd/
  2. .gitignore
  3. .travis.yml
  4. clean.sh
  5. doc.go
  6. doc_test.go
  7. example-crlf.toml
  8. example.toml
  9. keysparsing.go
  10. keysparsing_test.go
  11. lexer.go
  12. lexer_test.go
  13. LICENSE
  14. match.go
  15. match_test.go
  16. parser.go
  17. parser_test.go
  18. position.go
  19. position_test.go
  20. query.go
  21. query_test.go
  22. querylexer.go
  23. querylexer_test.go
  24. queryparser.go
  25. queryparser_test.go
  26. README.md
  27. test.sh
  28. token.go
  29. token_test.go
  30. toml.go
  31. toml_test.go
  32. tomltree_conversions.go
  33. tomltree_conversions_test.go
README.md

go-toml

Go library for the TOML format.

This library supports TOML version v0.4.0

GoDoc License Build Status Coverage Status Go Report Card

Features

Go-toml provides the following features for using data parsed from TOML documents:

  • Load TOML documents from files and string data
  • Easily navigate TOML structure using TomlTree
  • Line & column position data for all parsed elements
  • Query support similar to JSON-Path
  • Syntax errors contain line and column numbers

Go-toml is designed to help cover use-cases not covered by reflection-based TOML parsing:

  • Semantic evaluation of parsed TOML
  • Informing a user of mistakes in the source document, after it has been parsed
  • Programatic handling of default values on a case-by-case basis
  • Using a TOML document as a flexible data-store

Import

import "github.com/pelletier/go-toml"

Usage

Example

Say you have a TOML file that looks like this:

[postgres]
user = "pelletier"
password = "mypassword"

Read the username and password like this:

import (
    "fmt"
    "github.com/pelletier/go-toml"
)

config, err := toml.LoadFile("config.toml")
if err != nil {
    fmt.Println("Error ", err.Error())
} else {
    // retrieve data directly
    user := config.Get("postgres.user").(string)
    password := config.Get("postgres.password").(string)

    // or using an intermediate object
    configTree := config.Get("postgres").(*toml.TomlTree)
    user = configTree.Get("user").(string)
    password = configTree.Get("password").(string)
    fmt.Println("User is ", user, ". Password is ", password)

    // show where elements are in the file
    fmt.Println("User position: %v", configTree.GetPosition("user"))
    fmt.Println("Password position: %v", configTree.GetPosition("password"))

    // use a query to gather elements without walking the tree
    results, _ := config.Query("$..[user,password]")
    for ii, item := range results.Values() {
      fmt.Println("Query result %d: %v", ii, item)
    }
}

Documentation

The documentation and additional examples are available at godoc.org.

Tools

Go-toml provides two handy command line tools:

  • tomll: Reads TOML files and lint them.

    go install github.com/pelletier/go-toml/cmd/tomll
tomll --help

  • tomljson: Reads a TOML file and outputs its JSON representation.

    go install github.com/pelletier/go-toml/cmd/tomjson
tomljson --help

Contribute

Feel free to report bugs and patches using GitHub's pull requests system on pelletier/go-toml. Any feedback would be much appreciated!

Run tests

You have to make sure two kind of tests run:

  1. The Go unit tests
  2. The TOML examples base

You can run both of them using ./test.sh.

License

The MIT License (MIT). Read LICENSE.