comment

Documentation

Index

• func Move(key, val *yaml.Node)
• type Tag
  • func Parse(prefix string, n *yaml.Node) (string, Tag)
  • func Tags() []Tag
  • func (t Tag) ToYaml() string

Functions

func Move

func Move(key, val *yaml.Node)

Move moves a comment between yaml.Node entries after a style change. When a yaml.MappingNode or yaml.SequenceNode has an inline comment, the decoder will set LineComment differently according to the node's style.

When value(s) are on a single line (flow style), LineComment will be set on the value. When value(s) are on multiple lines (block style), LineComment will be set on the key.

If templating changes the node's style, the comment needs to move or else encoding errors will occur.

Types

type Tag

type Tag string

const (
	DynamicTag Tag = ""
	BoolTag    Tag = "bool"
	StrTag     Tag = "str"
	IntTag     Tag = "int"
	FloatTag   Tag = "float"
	SeqTag     Tag = "seq"
	MapTag     Tag = "map"
)

func Parse

func Parse(prefix string, n *yaml.Node) (string, Tag)

Parse returns the template and tag from a yaml.Node LineComment

func Tags

func Tags() []Tag

func (Tag) ToYaml

func (t Tag) ToYaml() string