workspace

package
v0.39.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 2, 2022 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func SortFilesInLibrary added in v0.13.0

func SortFilesInLibrary(files []*FileInLibrary)

Types

type DataLoader added in v0.27.0

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

func (DataLoader) FileData added in v0.27.0

func (l DataLoader) FileData(path string) ([]byte, error)

func (DataLoader) FilePaths added in v0.27.0

func (l DataLoader) FilePaths(path string) ([]string, error)

type DataValuesPreProcessing added in v0.15.0

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

DataValuesPreProcessing combines all data values documents (and any overlays) into a result set.

func (DataValuesPreProcessing) Apply added in v0.15.0

Apply executes the pre-processing of data values for all libraries.

Returns the data values for the root library and enveloped data values for children libraries.

type DataValuesSchemaPreProcessing added in v0.39.0

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

DataValuesSchemaPreProcessing combines all data values schema documents (and any overlays) into a result set.

func (DataValuesSchemaPreProcessing) Apply added in v0.39.0

Apply executes the pre-processing of schema for data values for all libraries.

Returns the schema for the root library and enveloped schema for children libraries.

type DocExtractor added in v0.31.0

type DocExtractor struct {
	DocSet *yamlmeta.DocumentSet
}

func (DocExtractor) Extract added in v0.31.0

type EvalExport added in v0.23.0

type EvalExport struct {
	Path    string
	Symbols starlark.StringDict
}

type EvalResult added in v0.15.0

type EvalResult struct {
	Files   []files.OutputFile
	DocSet  *yamlmeta.DocumentSet
	Exports []EvalExport
}

type FileInLibrary added in v0.5.0

type FileInLibrary struct {
	File    *files.File
	Library *Library
	// contains filtered or unexported fields
}

func (*FileInLibrary) RelativePath added in v0.15.0

func (fileInLib *FileInLibrary) RelativePath() string

type Library

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

func NewRootLibrary

func NewRootLibrary(fs []*files.File) *Library

func (*Library) CreateLibrary

func (l *Library) CreateLibrary(name string) *Library

func (*Library) FindAccessibleLibrary

func (l *Library) FindAccessibleLibrary(path string) (*Library, error)

func (*Library) FindFile

func (l *Library) FindFile(path string) (FileInLibrary, error)

func (*Library) FindLibrary

func (l *Library) FindLibrary(path string) (*Library, error)

func (*Library) ListAccessibleFiles

func (l *Library) ListAccessibleFiles() []*FileInLibrary

func (*Library) Print

func (l *Library) Print(out io.Writer)

func (*Library) PrintStr added in v0.24.0

func (l *Library) PrintStr() string

type LibraryExecution added in v0.36.0

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

func NewLibraryExecution added in v0.36.0

func NewLibraryExecution(libraryCtx LibraryExecutionContext,
	ui ui.UI, templateLoaderOpts TemplateLoaderOpts,
	libraryExecFactory *LibraryExecutionFactory) *LibraryExecution

func (*LibraryExecution) Eval added in v0.36.0

func (ll *LibraryExecution) Eval(values *datavalues.Envelope, libraryValues []*datavalues.Envelope, librarySchemas []*datavalues.SchemaEnvelope) (*EvalResult, error)

Eval runs this LibraryExecution, evaluating all templates in this library and then applying overlays over that result.

Returns the final set of Documents and output files. Returns an error if any template fails to evaluate, any overlay fails to apply, or if one or more "Envelopes" were not delivered/used.

func (*LibraryExecution) Schemas added in v0.36.0

Schemas calculates the final schema for the Data Values in this library by combining/overlaying the schema file(s) in the library and the passed-in overlays.

Returns this library's Schema and a slice of Schema intended for child libraries.

func (*LibraryExecution) Values added in v0.36.0

func (ll *LibraryExecution) Values(valuesOverlays []*datavalues.Envelope, schema *datavalues.Schema) (*datavalues.Envelope, []*datavalues.Envelope, error)

Values calculates the final Data Values for this library by combining/overlaying defaults from the schema, the Data Values file(s) in the library, and the passed-in Data Values overlays.

Returns this library's Data Values and a collection of Data Values addressed to child libraries. Returns an error if the overlay operation fails or the result over an overlay fails a schema check.

type LibraryExecutionContext added in v0.24.0

type LibraryExecutionContext struct {
	Current *Library
	Root    *Library
}

type LibraryExecutionFactory added in v0.23.0

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

func NewLibraryExecutionFactory added in v0.23.0

func NewLibraryExecutionFactory(ui ui.UI, templateLoaderOpts TemplateLoaderOpts) *LibraryExecutionFactory

func (*LibraryExecutionFactory) New added in v0.23.0

func (*LibraryExecutionFactory) WithTemplateLoaderOptsOverrides added in v0.31.0

func (f *LibraryExecutionFactory) WithTemplateLoaderOptsOverrides(overrides TemplateLoaderOptsOverrides) *LibraryExecutionFactory

type LibraryModule added in v0.23.0

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

func NewLibraryModule added in v0.23.0

func NewLibraryModule(libraryCtx LibraryExecutionContext,
	libraryExecutionFactory *LibraryExecutionFactory,
	libraryValues []*datavalues.Envelope, librarySchemas []*datavalues.SchemaEnvelope) LibraryModule

func (LibraryModule) AsModule added in v0.23.0

func (b LibraryModule) AsModule() starlark.StringDict

func (LibraryModule) Get added in v0.23.0

func (b LibraryModule) Get(thread *starlark.Thread, f *starlark.Builtin,
	args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)

type OverlayPostProcessing added in v0.15.0

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

func (OverlayPostProcessing) Apply added in v0.15.0

type TemplateLoader

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

func NewTemplateLoader

func NewTemplateLoader(values *datavalues.Envelope, libraryValuess []*datavalues.Envelope, librarySchemas []*datavalues.SchemaEnvelope, opts TemplateLoaderOpts, libraryExecFactory *LibraryExecutionFactory, ui ui.UI) *TemplateLoader

NewTemplateLoader instantiates a new TemplateLoader.

func (*TemplateLoader) EvalPlainYAML added in v0.36.0

func (l *TemplateLoader) EvalPlainYAML(file *files.File) (*yamlmeta.DocumentSet, error)

func (*TemplateLoader) EvalStarlark

func (l *TemplateLoader) EvalStarlark(libraryCtx LibraryExecutionContext, file *files.File) (starlark.StringDict, error)

func (*TemplateLoader) EvalText

func (*TemplateLoader) EvalYAML

func (*TemplateLoader) FindCompiledTemplate

func (l *TemplateLoader) FindCompiledTemplate(path string) (*template.CompiledTemplate, error)

func (*TemplateLoader) Load

func (l *TemplateLoader) Load(thread *starlark.Thread, module string) (starlark.StringDict, error)

type TemplateLoaderOpts added in v0.12.0

type TemplateLoaderOpts struct {
	IgnoreUnknownComments   bool
	ImplicitMapKeyOverrides bool
	StrictYAML              bool
	SchemaEnabled           bool
}

func (TemplateLoaderOpts) Merge added in v0.31.0

type TemplateLoaderOptsOverrides added in v0.31.0

type TemplateLoaderOptsOverrides struct {
	IgnoreUnknownComments   *bool
	ImplicitMapKeyOverrides *bool
	StrictYAML              *bool
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL