bench-forgejo/vendor/github.com/pelletier/go-toml
6543 792b4dba2c
[Vendor] Update directly used dependencys (#15593)
* update github.com/blevesearch/bleve v2.0.2 -> v2.0.3

* github.com/denisenkom/go-mssqldb v0.9.0 -> v0.10.0

* github.com/editorconfig/editorconfig-core-go v2.4.1 -> v2.4.2

* github.com/go-chi/cors v1.1.1 -> v1.2.0

* github.com/go-git/go-billy v5.0.0 -> v5.1.0

* github.com/go-git/go-git v5.2.0 -> v5.3.0

* github.com/go-ldap/ldap v3.2.4 -> v3.3.0

* github.com/go-redis/redis v8.6.0 -> v8.8.2

* github.com/go-sql-driver/mysql v1.5.0 -> v1.6.0

* github.com/go-swagger/go-swagger v0.26.1 -> v0.27.0

* github.com/lib/pq v1.9.0 -> v1.10.1

* github.com/mattn/go-sqlite3 v1.14.6 -> v1.14.7

* github.com/go-testfixtures/testfixtures v3.5.0 -> v3.6.0

* github.com/issue9/identicon v1.0.1 -> v1.2.0

* github.com/klauspost/compress v1.11.8 -> v1.12.1

* github.com/mgechev/revive v1.0.3 -> v1.0.6

* github.com/microcosm-cc/bluemonday v1.0.7 -> v1.0.8

* github.com/niklasfasching/go-org v1.4.0 -> v1.5.0

* github.com/olivere/elastic v7.0.22 -> v7.0.24

* github.com/pelletier/go-toml v1.8.1 -> v1.9.0

* github.com/prometheus/client_golang v1.9.0 -> v1.10.0

* github.com/xanzy/go-gitlab v0.44.0 -> v0.48.0

* github.com/yuin/goldmark v1.3.3 -> v1.3.5

* github.com/6543/go-version v1.2.4 -> v1.3.1

* do github.com/lib/pq v1.10.0 -> v1.10.1 again ...
2021-04-22 20:08:53 -04:00
..
.dockerignore Use vendored go-swagger (#8087) 2019-09-04 22:53:54 +03:00
.gitignore Use vendored go-swagger (#8087) 2019-09-04 22:53:54 +03:00
azure-pipelines.yml [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
benchmark.sh update revive lint to latest commit (#12921) 2020-09-22 20:02:16 +03:00
CONTRIBUTING.md [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
doc.go [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
Dockerfile [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
example-crlf.toml [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
example.toml [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
fuzz.go Use vendored go-swagger (#8087) 2019-09-04 22:53:54 +03:00
fuzz.sh Use vendored go-swagger (#8087) 2019-09-04 22:53:54 +03:00
go.mod [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
keysparsing.go [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
lexer.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
LICENSE [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
localtime.go [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
Makefile [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
marshal.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
marshal_OrderPreserve_test.toml [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
marshal_test.toml [Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670) 2020-09-01 10:01:23 -04:00
parser.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
position.go Use vendored go-swagger (#8087) 2019-09-04 22:53:54 +03:00
PULL_REQUEST_TEMPLATE.md Use vendored go-swagger (#8087) 2019-09-04 22:53:54 +03:00
README.md [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
token.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
toml.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
tomlpub.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
tomltree_create.go update revive lint to latest commit (#12921) 2020-09-22 20:02:16 +03:00
tomltree_write.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00
tomltree_writepub.go [Vendor] Update directly used dependencys (#15593) 2021-04-22 20:08:53 -04:00

go-toml

Go library for the TOML format.

This library supports TOML version v1.0.0-rc.3

Go Reference license 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
  • Marshaling 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.Printf("Query result %d: %v\n", ii, item)
}

Documentation

The documentation and additional examples are available at pkg.go.dev.

Tools

Go-toml provides three handy command line tools:

  • tomll: Reads TOML files and lints 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
    
  • jsontoml: Reads a JSON file and outputs a TOML representation.

    go install github.com/pelletier/go-toml/cmd/jsontoml
    jsontoml --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.