yamlcomment

README

yaml-comment

golang yaml comment encoder

How to use

package main

import (
    "fmt"
    "github.com/zijiren233/yaml-comment"
)

type Config struct {
    Name string `yaml:"name,omitempty" hc:"this is head comment"`
    Age  int    `yaml:"age,omitempty" lc:"this is line comment" fc:"this is foot comment"`
}

func main() {
    c := Config{
        Name: "comment",
        Age:  18,
    }
    data, err := yamlcomment.Marshal(c)
	if err != nil {
		panic(err)
	}
    fmt.Println(string(data))
}

Output

# this is head comment
name: comment
age: 18 # this is line comment
# this is foot comment

Documentation

Index

• Constants
• func AnyToYamlNode(model any) (*yaml.Node, error)
• func Marshal(v any) ([]byte, error)
• type CommentEncoder
  • func NewEncoder(encoder *yaml.Encoder) *CommentEncoder
  • func (e *CommentEncoder) Encode(v any) error

Constants

const (
	HeadCommentTag = "hc"
	LineCommentTag = "lc"
	FootCommentTag = "fc"
	OmitemptyTag   = "omitempty"
	InlineTag      = "inline"
	FlowTag        = "flow"
)

Functions

func AnyToYamlNode

func AnyToYamlNode(model any) (*yaml.Node, error)

func Marshal

func Marshal(v any) ([]byte, error)

Types

type CommentEncoder

type CommentEncoder struct {
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(encoder *yaml.Encoder) *CommentEncoder

func (*CommentEncoder) Encode

func (e *CommentEncoder) Encode(v any) error