imagetemplate

README

Image Template

An image templating library for golang. Builder provides the templating engine, render provides the canvas, individual components provide the elements which can be templated and rendered. Component registration follows the pattern of built-in package "image", any package which implements the Component interface (found under render) and uses the RegisterComponent function during initialisation will be available for use.

Several default components are included, see their documentation as well as detailed usage guidelines for the template files and Builder in the documentation pages.

Installation

go get "github.com/LLKennedy/imagetemplate/v3"

Basic Usage

loader, props, err := imagetemplate.New().Load().FromFile("template.json")

// Check props here, set any discovered variables with real values

data, err := loader.Write().ToBMP(props)
err = ioutil.WriteFile("output.bmp", data, os.ModeExclusive)

Testing

On windows, the simplest way to test is to use the powershell script.

./test.ps1

To emulate the testing which occurs in build pipelines for linux and mac, run the following:

go test . ./components/... ./render/... ./scaffold/... ./internal/filesystem -race -coverprofile=coverage.out;

Documentation

Index

• type LoadOptions
• type Loader
  • func New() Loader
  • func NewUsing(fs vfs.FileSystem) Loader
• type WriteOptions

Types

type LoadOptions

type LoadOptions interface {
	FromBuilder(builder scaffold.Builder) (Loader, render.NamedProperties, error)
	FromBytes(bytes []byte) (Loader, render.NamedProperties, error)
	FromFile(path string) (Loader, render.NamedProperties, error)
	FromJSON(raw json.RawMessage) (Loader, render.NamedProperties, error)
	FromReader(reader io.Reader) (Loader, render.NamedProperties, error)
}

LoadOptions chooses the input format for Loader

type Loader

type Loader interface {
	Load() LoadOptions
	Write() WriteOptions
}

Loader creates image builders from several input options and writes the finished product to several output formats.

func New

func New() Loader

New returns a new loader with the default file system

func NewUsing

func NewUsing(fs vfs.FileSystem) Loader

NewUsing returns a new loader using a specified vfs

type WriteOptions

type WriteOptions interface {
	ToBuilder(props render.NamedProperties) (scaffold.Builder, error)
	ToBMP(props render.NamedProperties) ([]byte, error)
	ToCanvas(props render.NamedProperties) (render.Canvas, error)
	ToImage(props render.NamedProperties) (image.Image, error)
	ToBMPReader(props render.NamedProperties) (io.Reader, error)
}

WriteOptions chooses the output format for Loader