jsonnet

Documentation

Index

• func Evaluate(path, data string, opts Opts) (string, error)
• func EvaluateFile(jsonnetFile string, opts Opts) (string, error)
• func MakeVM(opts Opts) *jsonnet.VM
• func TransitiveImports(dir string) ([]string, error)
• type ExtendedImporter
  • func NewExtendedImporter(jpath []string) *ExtendedImporter
  • func (i *ExtendedImporter) Import(importedFrom, importedPath string) (contents jsonnet.Contents, foundAt string, err error)
• type FileEvalCache
  • func NewFileEvalCache(cachePath string) *FileEvalCache
  • func (c *FileEvalCache) Get(hash string) (string, error)
  • func (c *FileEvalCache) Store(hash, content string) error
• type InjectedCode
  • func (i *InjectedCode) Set(key, value string)
• type Modifier
• type Opts
  • func (o Opts) Clone() Opts
  • func (opts Opts) PathIsCached(path string) bool

Functions

func Evaluate

func Evaluate(path, data string, opts Opts) (string, error)

Evaluate renders the given jsonnet into a string If cache options are given, a hash from the data will be computed and

the resulting string will be cached for future retrieval

func EvaluateFile

func EvaluateFile(jsonnetFile string, opts Opts) (string, error)

EvaluateFile evaluates the Jsonnet code in the given file and returns the result in JSON form. It disregards opts.ImportPaths in favor of automatically resolving these according to the specified file.

func MakeVM

func MakeVM(opts Opts) *jsonnet.VM

MakeVM returns a Jsonnet VM with some extensions of Tanka, including: - extended importer - extCode and tlaCode applied - native functions registered

func TransitiveImports

func TransitiveImports(dir string) ([]string, error)

TransitiveImports returns all recursive imports of an environment

Types

type ExtendedImporter

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

ExtendedImporter wraps jsonnet.FileImporter to add additional functionality: - `import "file.yaml"` - `import "tk"`

func NewExtendedImporter

func NewExtendedImporter(jpath []string) *ExtendedImporter

NewExtendedImporter returns a new instance of ExtendedImporter with the correct jpaths set up

func (*ExtendedImporter) Import

func (i *ExtendedImporter) Import(importedFrom, importedPath string) (contents jsonnet.Contents, foundAt string, err error)

Import implements the functionality offered by the ExtendedImporter

type FileEvalCache

type FileEvalCache struct {
	Directory string
}

FileEvalCache is an evaluation cache that stores its data on the local filesystem

func NewFileEvalCache

func NewFileEvalCache(cachePath string) *FileEvalCache

func (*FileEvalCache) Get

func (c *FileEvalCache) Get(hash string) (string, error)

func (*FileEvalCache) Store

func (c *FileEvalCache) Store(hash, content string) error

type InjectedCode

type InjectedCode map[string]string

InjectedCode holds data that is "late-bound" into the VM

func (*InjectedCode) Set

func (i *InjectedCode) Set(key, value string)

Set allows to set values on an InjectedCode, even when it is nil

type Modifier

type Modifier func(vm *jsonnet.VM) error

Modifier allows to set optional parameters on the Jsonnet VM. See jsonnet.With* for this.

type Opts

type Opts struct {
	ExtCode     InjectedCode
	TLACode     InjectedCode
	ImportPaths []string
	EvalScript  string
	CachePath   string

	CachePathRegexes []*regexp.Regexp
}

Opts are additional properties for the Jsonnet VM

func (Opts) Clone

func (o Opts) Clone() Opts

Clone returns a deep copy of Opts

func (Opts) PathIsCached

func (opts Opts) PathIsCached(path string) bool

PathIsCached determines if a given path is matched by any of the configured cached path regexes If no path regexes are defined, all paths are matched