go-yaml v3 fork containing code to encode a struct back into the source node from whence it came.
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.
Benjamin Shelton 9919cbe8a5 Re-enable map support. 1 week ago
temp gofmt and correct package imports to test THIS package. 1 month ago
.travis.yml Update travis config to use latest go versions (#541) 4 months ago
LICENSE Clarify licensing. 1 year ago
NOTICE Create NOTICE 2 years ago
README.md Update README for v3. 1 year ago
apic.go Clarify licensing. 1 year ago
decode.go Improve heuristics preventing CPU/memory abuse (#515) 6 months ago
decode_test.go gofmt and correct package imports to test THIS package. 1 month ago
emitterc.go Fix sequence indent of 2 under map after comment (#508) 6 months ago
encode.go Do not mutate Node tree on encoding (#532) 5 months ago
encode_test.go gofmt and correct package imports to test THIS package. 1 month ago
example_embedded_test.go gofmt and correct package imports to test THIS package. 1 month ago
go.mod Moved package. 1 month ago
limit_test.go gofmt and correct package imports to test THIS package. 1 month ago
node_test.go gofmt and correct package imports to test THIS package. 1 month ago
parserc.go Better handling of line comments in nested sequences 5 months ago
readerc.go Clarify licensing. 1 year ago
resolve.go Clarify licensing. 1 year ago
scannerc.go Fix line comments under lists (#550) 4 months ago
sorter.go Fix instability in key ordering. 1 year ago
suite_test.go Clarify licensing. 1 year ago
transcode.go Re-enable map support. 1 week ago
writerc.go Clarify licensing. 1 year ago
yaml.go Not quite there, but we're seeing nodes! 2 months ago
yamlh.go Better handling of line comments in nested sequences 5 months ago
yamlprivateh.go Fix scanning of long comment lines. 9 months ago

README.md

YAML support for the Go language

Introduction

The yaml package enables Go programs to comfortably encode and decode YAML values. It was developed within Canonical as part of the juju project, and is based on a pure Go port of the well-known libyaml C library to parse and generate YAML data quickly and reliably.

Compatibility

The yaml package supports most of YAML 1.2, but preserves some behavior from 1.1 for backwards compatibility.

Specifically, as of v3 of the yaml package:

  • YAML 1.1 bools (yes/no, on/off) are supported as long as they are being decoded into a typed bool value. Otherwise they behave as a string. Booleans in YAML 1.2 are true/false only.
  • Octals encode and decode as 0777 per YAML 1.1, rather than 0o777 as specified in YAML 1.2, because most parsers still use the old format. Octals in the 0o777 format are supported though, so new files work.
  • Does not support base-60 floats. These are gone from YAML 1.2, and were actually never supported by this package as it's clearly a poor choice.

and offers backwards compatibility with YAML 1.1 in some cases. 1.2, including support for anchors, tags, map merging, etc. Multi-document unmarshalling is not yet implemented, and base-60 floats from YAML 1.1 are purposefully not supported since they're a poor design and are gone in YAML 1.2.

Installation and usage

The import path for the package is gopkg.in/yaml.v3.

To install it, run:

go get gopkg.in/yaml.v3

API documentation

If opened in a browser, the import path itself leads to the API documentation:

API stability

The package API for yaml v3 will remain stable as described in gopkg.in.

License

The yaml package is licensed under the MIT and Apache License 2.0 licenses. Please see the LICENSE file for details.

Example

package main

import (
        "fmt"
        "log"

        "gopkg.in/yaml.v3"
)

var data = `
a: Easy!
b:
  c: 2
  d: [3, 4]
`

// Note: struct fields must be public in order for unmarshal to
// correctly populate the data.
type T struct {
        A string
        B struct {
                RenamedC int   `yaml:"c"`
                D        []int `yaml:",flow"`
        }
}

func main() {
        t := T{}
    
        err := yaml.Unmarshal([]byte(data), &t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t:\n%v\n\n", t)
    
        d, err := yaml.Marshal(&t)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- t dump:\n%s\n\n", string(d))
    
        m := make(map[interface{}]interface{})
    
        err = yaml.Unmarshal([]byte(data), &m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m:\n%v\n\n", m)
    
        d, err = yaml.Marshal(&m)
        if err != nil {
                log.Fatalf("error: %v", err)
        }
        fmt.Printf("--- m dump:\n%s\n\n", string(d))
}

This example will generate the following output:

--- t:
{Easy! {2 [3 4]}}

--- t dump:
a: Easy!
b:
  c: 2
  d: [3, 4]


--- m:
map[a:Easy! b:map[c:2 d:[3 4]]]

--- m dump:
a: Easy!
b:
  c: 2
  d:
  - 3
  - 4