output

package

v0.0.78 Latest Latest Go to latest Published: Jun 3, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func ToYaml(root Root, out io.Writer, tabsize int, commentDefaults, excludeDefaults bool)

ToYaml create a yaml output of the configuration. Tab size, comment out default values, or exclude default values are configurable options.

type Attribute struct {
	FullName          string
	IsDefault         bool
	AdditionalComment string
	Value             interface{}
}

Attribute contains setting of a single value.

func (a Attribute) ShortName() string

ShortName of an attributes FullName split by ".".

type Element struct {
	FullName   string
	Attributes []Attribute
	Elements   []Element
}

Element groups settings and child groups of settings.

func (e Element) IsDefault() bool

IsDefault checks the entire Element and child Elements and Attributes to deterimine if all values are default.

func (e Element) ShortName() string

ShortName of the element split by ".".

func (e Element) SortedAttributes() []Attribute

SortedAttributes to ensure that `[]Attribute` slice is sorted consistently.

func (e Element) SortedElements() []Element

SortedElements to ensure that `[]Element` slice is sorted consistently.

type Root struct {
	Elements []Element
}

Root element for that contains only `[]Element` structs.