template

Documentation

Index

• func DirInputProvider(dir fs.FS) <-chan *Data
• func FileGlobsToFileNames(globs ...string) ([]string, error)
• func FileInputProvider(filenames ...string) <-chan *Data
• func ReaderProvider(name string, reader io.Reader) <-chan *Data
• type Config
• type ContextBuilder
  • func NewContextBuilder() *ContextBuilder
  • func (cb *ContextBuilder) Build() (context map[string]interface{}, err error)
  • func (cb *ContextBuilder) SupportedTypes() []string
  • func (cb *ContextBuilder) WithAnyInScope(context interface{}, scope string) *ContextBuilder
  • func (cb *ContextBuilder) WithByTypeInScope(ext, text, scope string) error
  • func (cb *ContextBuilder) WithEnv(scope string) *ContextBuilder
  • func (cb *ContextBuilder) WithJsonInScope(text, scope string) error
  • func (cb *ContextBuilder) WithMap(context map[string]interface{}) *ContextBuilder
  • func (cb *ContextBuilder) WithProperties(text, scope string) error
  • func (cb *ContextBuilder) WithToml(text, scope string) error
  • func (cb *ContextBuilder) WithYamlInScope(text, scope string) error
• type Data
• type Engine
  • func NewEngine(config Config) Engine
• type Renderer
  • func NewRenderer() *Renderer
  • func (r *Renderer) Clone() *Renderer
  • func (r *Renderer) From(fromFunc Source) *Renderer
  • func (r *Renderer) Render() (err error)
  • func (r *Renderer) To(toFunc Transform) *Renderer
  • func (r *Renderer) WithConfig(config Config) *Renderer
  • func (r *Renderer) WithFiles(filesFunc Source) *Renderer
  • func (r *Renderer) WithReferenceTemplates(refFunc Source) *Renderer
  • func (r *Renderer) WithValues(valuesFunc Source) *Renderer
• type Source
  • func DirInputSource(dir fs.FS) Source
  • func FileInputSource(filenames ...string) Source
  • func ReaderSource(name string, reader io.Reader) Source
• type Transform
  • func DirOutputSink(dirpath string, removeexts ...string) (Transform, error)
  • func FileOutputSink(filename string) (Transform, error)
  • func WriterSink(writer io.Writer) Transform

Functions

func DirInputProvider

func DirInputProvider(dir fs.FS) <-chan *Data

func FileGlobsToFileNames

func FileGlobsToFileNames(globs ...string) ([]string, error)

func FileInputProvider

func FileInputProvider(filenames ...string) <-chan *Data

func ReaderProvider

func ReaderProvider(name string, reader io.Reader) <-chan *Data

Types

type Config

type Config struct {
	Strict bool
}

type ContextBuilder

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

func NewContextBuilder

func NewContextBuilder() *ContextBuilder

func (*ContextBuilder) Build

func (cb *ContextBuilder) Build() (context map[string]interface{}, err error)

func (*ContextBuilder) SupportedTypes

func (cb *ContextBuilder) SupportedTypes() []string

func (*ContextBuilder) WithAnyInScope

func (cb *ContextBuilder) WithAnyInScope(context interface{}, scope string) *ContextBuilder

func (*ContextBuilder) WithByTypeInScope

func (cb *ContextBuilder) WithByTypeInScope(ext, text, scope string) error

func (*ContextBuilder) WithEnv

func (cb *ContextBuilder) WithEnv(scope string) *ContextBuilder

func (*ContextBuilder) WithJsonInScope

func (cb *ContextBuilder) WithJsonInScope(text, scope string) error

func (*ContextBuilder) WithMap

func (cb *ContextBuilder) WithMap(context map[string]interface{}) *ContextBuilder

func (*ContextBuilder) WithProperties

func (cb *ContextBuilder) WithProperties(text, scope string) error

func (*ContextBuilder) WithToml

func (cb *ContextBuilder) WithToml(text, scope string) error

func (*ContextBuilder) WithYamlInScope

func (cb *ContextBuilder) WithYamlInScope(text, scope string) error

type Data

type Data struct {
	Name    string
	Content string
	Error   error
}

type Engine

type Engine interface {
	AddReferenceTemplate(name string, renderable string) error
	Render(renderable string, context map[string]interface{}) (string, error)
}

func NewEngine

func NewEngine(config Config) Engine

type Renderer

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

func NewRenderer

func NewRenderer() *Renderer

func (*Renderer) Clone

func (r *Renderer) Clone() *Renderer

func (*Renderer) From

func (r *Renderer) From(fromFunc Source) *Renderer

func (*Renderer) Render

func (r *Renderer) Render() (err error)

func (*Renderer) To

func (r *Renderer) To(toFunc Transform) *Renderer

func (*Renderer) WithConfig

func (r *Renderer) WithConfig(config Config) *Renderer

func (*Renderer) WithFiles

func (r *Renderer) WithFiles(filesFunc Source) *Renderer

func (*Renderer) WithReferenceTemplates

func (r *Renderer) WithReferenceTemplates(refFunc Source) *Renderer

func (*Renderer) WithValues

func (r *Renderer) WithValues(valuesFunc Source) *Renderer

type Source

type Source func() <-chan *Data

func DirInputSource

func DirInputSource(dir fs.FS) Source

func FileInputSource

func FileInputSource(filenames ...string) Source

func ReaderSource

func ReaderSource(name string, reader io.Reader) Source

type Transform

type Transform func(<-chan *Data) <-chan *Data

func DirOutputSink

func DirOutputSink(dirpath string, removeexts ...string) (Transform, error)

func FileOutputSink

func FileOutputSink(filename string) (Transform, error)

func WriterSink

func WriterSink(writer io.Writer) Transform