xpand

README

xpand - A tiny text/template expander

Installation

go get github.com/m0t0k1ch1-go/xpand

Documentation

Index

• Constants
• func File(ctx context.Context, path string, opts ...Option) ([]byte, error)
• type Option
  • func WithDelims(left, right string) Option
  • func WithResolver(scheme string, resolver Resolver) Option
• type Resolver

Constants

const (
	SchemeRaw = "raw"
	SchemeEnv = "env"
)

const (
	DefaultLeftDelim  = "{{"
	DefaultRightDelim = "}}"
)

Functions

func File

func File(ctx context.Context, path string, opts ...Option) ([]byte, error)

File reads the file at path, expands it as a text/template, and returns the result.

Types

type Option

type Option func(*options)

Option configures the expansion.

func WithDelims

func WithDelims(left, right string) Option

WithDelims sets the action delimiters. Empty values stand for the defaults.

func WithResolver

func WithResolver(scheme string, resolver Resolver) Option

WithResolver registers the resolver for the scheme. It overrides the resolver already registered for the same scheme, including the built-in ones.

type Resolver

type Resolver func(ctx context.Context, key string) (string, bool, error)

Resolver resolves the value for key. The second return value reports whether the value was resolved.