internal

package

v0.0.0-...-4a6c938 Latest Latest Go to latest Published: Dec 18, 2023 License: GPL-3.0 Imports: 17 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.

This section is empty.

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

Expander holds the state of the goyamp engine. It is not a singleton type, have as many as you want.

func NewExpander(commandArgs []string, environment []string, ow io.Writer, format Syntax, version string) Expander

NewExpander creates a Goyamp macro expansion engine.

func (engine *Expander) ExpandFile(filename string) (err error)

ExpandFile reads a file of YAML given a path

func (engine *Expander) ExpandStream(input io.Reader, filename string) (err error)

ExpandStream reads a stream of YAML and expands it.

type Syntax int

Syntax holds different output format syntaxes

const (
	YAML Syntax = iota + 0
	JSON
	LINES
)

Constants for YAML and JSON syntax