internal

Documentation

Index

• type Expander
  • func NewExpander(commandArgs []string, environment []string, ow io.Writer, format Syntax, ...) Expander
  • func (engine *Expander) ExpandFile(filename string) (err error)
  • func (engine *Expander) ExpandStream(input io.Reader, filename string) (err error)
• type Syntax

Types

type Expander

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

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

NewExpander creates a Goyamp macro expansion engine.

func (*Expander) ExpandFile

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

ExpandFile reads a file of YAML given a path

func (*Expander) ExpandStream

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

ExpandStream reads a stream of YAML and expands it.

type Syntax

type Syntax int

Syntax holds different output format syntaxes

const (
	YAML Syntax = iota + 0
	JSON
	LINES
)

Constants for YAML and JSON syntax