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.
 
 
 
 
 
 
gitea/vendor/github.com/pelletier/go-toml
Antoine GIRARD 9fe4437bda Use vendored go-swagger (#8087) 5 years ago
..
.dockerignore Use vendored go-swagger (#8087) 5 years ago
.gitignore Use vendored go-swagger (#8087) 5 years ago
.travis.yml Use vendored go-swagger (#8087) 5 years ago
CONTRIBUTING.md Use vendored go-swagger (#8087) 5 years ago
Dockerfile Use vendored go-swagger (#8087) 5 years ago
LICENSE Use vendored go-swagger (#8087) 5 years ago
PULL_REQUEST_TEMPLATE.md Use vendored go-swagger (#8087) 5 years ago
README.md Use vendored go-swagger (#8087) 5 years ago
appveyor.yml Use vendored go-swagger (#8087) 5 years ago
benchmark.json Use vendored go-swagger (#8087) 5 years ago
benchmark.sh Use vendored go-swagger (#8087) 5 years ago
benchmark.toml Use vendored go-swagger (#8087) 5 years ago
benchmark.yml Use vendored go-swagger (#8087) 5 years ago
doc.go Use vendored go-swagger (#8087) 5 years ago
example-crlf.toml Use vendored go-swagger (#8087) 5 years ago
example.toml Use vendored go-swagger (#8087) 5 years ago
fuzz.go Use vendored go-swagger (#8087) 5 years ago
fuzz.sh Use vendored go-swagger (#8087) 5 years ago
go.mod Use vendored go-swagger (#8087) 5 years ago
go.sum Use vendored go-swagger (#8087) 5 years ago
keysparsing.go Use vendored go-swagger (#8087) 5 years ago
lexer.go Use vendored go-swagger (#8087) 5 years ago
marshal.go Use vendored go-swagger (#8087) 5 years ago
marshal_OrderPreserve_Map_test.toml Use vendored go-swagger (#8087) 5 years ago
marshal_OrderPreserve_test.toml Use vendored go-swagger (#8087) 5 years ago
marshal_test.toml Use vendored go-swagger (#8087) 5 years ago
parser.go Use vendored go-swagger (#8087) 5 years ago
position.go Use vendored go-swagger (#8087) 5 years ago
token.go Use vendored go-swagger (#8087) 5 years ago
toml.go Use vendored go-swagger (#8087) 5 years ago
tomltree_create.go Use vendored go-swagger (#8087) 5 years ago
tomltree_write.go Use vendored go-swagger (#8087) 5 years ago

README.md

go-toml

Go library for the TOML format.

This library supports TOML version v0.4.0

GoDoc license Build Status Windows Build status codecov Go Report Card FOSSA Status

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 Tree
  • Mashaling and unmarshaling to and from data structures
  • Line & column position data for all parsed elements
  • Query support similar to JSON-Path
  • Syntax errors contain line and column numbers

Import

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

Usage example

Read a TOML document:

config, _ := toml.Load(`
[postgres]
user = "pelletier"
password = "mypassword"`)
// retrieve data directly
user := config.Get("postgres.user").(string)

// or using an intermediate object
postgresConfig := config.Get("postgres").(*toml.Tree)
password := postgresConfig.Get("password").(string)

Or use Unmarshal:

type Postgres struct {
    User     string
    Password string
}
type Config struct {
    Postgres Postgres
}

doc := []byte(`
[Postgres]
User = "pelletier"
Password = "mypassword"`)

config := Config{}
toml.Unmarshal(doc, &config)
fmt.Println("user=", config.Postgres.User)

Or use a query:

// use a query to gather elements without walking the tree
q, _ := query.Compile("$..[user,password]")
results := q.Execute(config)
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/tomljson
    tomljson --help
    

Docker image

Those tools are also availble as a Docker image from dockerhub. For example, to use tomljson:

docker run -v $PWD:/workdir pelletier/go-toml tomljson /workdir/example.toml

Only master (latest) and tagged versions are published to dockerhub. You can build your own image as usual:

docker build -t go-toml .

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

go test ./...

Fuzzing

The script ./fuzz.sh is available to run go-fuzz on go-toml.

Versioning

Go-toml follows Semantic Versioning. The supported version of TOML is indicated at the beginning of this document. The last two major versions of Go are supported (see Go Release Policy).

License

The MIT License (MIT). Read LICENSE.