templates

Documentation

Index

• func ApplyTemplate(t string, data any) (string, error)
• func ApplyTemplateFrom(fs shared.FileSystem, f string, obj any) (string, error)
• func Copy(fs shared.FileSystem, f shared.File, destination shared.File) error
• func CopyAndApply(logger shared.BaseLogger, fs shared.FileSystem, root shared.Dir, ...) error
• func CopyAndApplyTemplate(fs shared.FileSystem, f shared.File, destination shared.File, obj any) error
• func CopyAndReplace(fs shared.FileSystem, f shared.File, destination shared.File, ...) error
• func CopyAndVisit(logger shared.BaseLogger, fs shared.FileSystem, root shared.Dir, ...) error
• func Walk(logger shared.BaseLogger, fs shared.FileSystem, root shared.Dir, ignore Ignore, ...) error
• type AlreadyExistError
  • func (a AlreadyExistError) Error() string
• type FileVisitor
• type Ignore
• type IgnorePatterns
  • func NewIgnore(patterns ...string) IgnorePatterns
  • func (ign IgnorePatterns) Ignore(file shared.File) bool
• type NoIgnore
  • func (i *NoIgnore) Ignore(file shared.File) bool
• type NoOpIgnore
  • func (ign NoOpIgnore) Ignore(file shared.File) bool
• type Override
• type OverrideAll
  • func (o *OverrideAll) Override(string) bool
• type Replacer
• type ServiceReplacer
  • func NewServiceReplacer(gen *generation.Service) *ServiceReplacer
  • func (r *ServiceReplacer) Do(content []byte) ([]byte, error)
• type SkipOnExist
  • func (o *SkipOnExist) Override(string) bool
• type Source
• type TemplateOption
  • func Option(relativePath string, opts ...TemplateOptionFunc) *TemplateOption
• type TemplateOptionFunc
  • func WithIgnore(ignore Ignore) TemplateOptionFunc
  • func WithOverrideAll() TemplateOptionFunc
  • func WithOverridePolicy(override Override) TemplateOptionFunc

Functions

func ApplyTemplate

func ApplyTemplate(t string, data any) (string, error)

ApplyTemplate takes a YAML template as []byte, populates it using data, and returns the result as a string.

func ApplyTemplateFrom

func ApplyTemplateFrom(fs shared.FileSystem, f string, obj any) (string, error)

func Copy

func Copy(fs shared.FileSystem, f shared.File, destination shared.File) error

func CopyAndApply

func CopyAndApply(logger shared.BaseLogger, fs shared.FileSystem, root shared.Dir, destination shared.Dir, obj any, opts ...TemplateOptionFunc) error

func CopyAndApplyTemplate

func CopyAndApplyTemplate(fs shared.FileSystem, f shared.File, destination shared.File, obj any) error

func CopyAndReplace

func CopyAndReplace(fs shared.FileSystem, f shared.File, destination shared.File, replacer Replacer) error

func CopyAndVisit

func CopyAndVisit(logger shared.BaseLogger, fs shared.FileSystem, root shared.Dir, destination shared.Dir, visitor FileVisitor) error

func Walk

func Walk(logger shared.BaseLogger, fs shared.FileSystem, root shared.Dir, ignore Ignore, files *[]shared.File, dirs *[]shared.Dir) error

Types

type AlreadyExistError

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

func (AlreadyExistError) Error

func (a AlreadyExistError) Error() string

type FileVisitor

type FileVisitor interface {
	Apply(path shared.File, to shared.Dir) error
	Ignore(file shared.File) bool
}

type Ignore

type Ignore interface {
	Ignore(file shared.File) bool
}

type IgnorePatterns

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

func NewIgnore

func NewIgnore(patterns ...string) IgnorePatterns

func (IgnorePatterns) Ignore

func (ign IgnorePatterns) Ignore(file shared.File) bool

type NoIgnore

type NoIgnore struct {
}

func (*NoIgnore) Ignore

func (i *NoIgnore) Ignore(file shared.File) bool

type NoOpIgnore

type NoOpIgnore struct{}

func (NoOpIgnore) Ignore

func (ign NoOpIgnore) Ignore(file shared.File) bool

type Override

type Override interface {
	Override(string) bool
}

type OverrideAll

type OverrideAll struct{}

func (*OverrideAll) Override

func (o *OverrideAll) Override(string) bool

type Replacer

type Replacer interface {
	Do([]byte) ([]byte, error)
}

type ServiceReplacer

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

func NewServiceReplacer

func NewServiceReplacer(gen *generation.Service) *ServiceReplacer

func (*ServiceReplacer) Do

func (r *ServiceReplacer) Do(content []byte) ([]byte, error)

type SkipOnExist

type SkipOnExist struct{}

func (*SkipOnExist) Override

func (o *SkipOnExist) Override(string) bool

type Source

type Source interface {
	ReadDir(dir shared.Dir) ([]os.DirEntry, error)
	ReadFile(file shared.File) ([]byte, error)
	Next() Source
}

type TemplateOption

type TemplateOption struct {
	Destination string
	Ignore
	Override
}

func Option

func Option(relativePath string, opts ...TemplateOptionFunc) *TemplateOption

type TemplateOptionFunc

type TemplateOptionFunc func(*TemplateOption)

func WithIgnore

func WithIgnore(ignore Ignore) TemplateOptionFunc

func WithOverrideAll

func WithOverrideAll() TemplateOptionFunc

func WithOverridePolicy

func WithOverridePolicy(override Override) TemplateOptionFunc