runtime

Documentation

Index

• type DatamodelEnricher
• type GeneratorEnricher
• type Runtime
  • func New(entrypoints []string, rflags flags.RootPflagpole) (*Runtime, error)
  • func (R *Runtime) EnrichDatamodels(datamodels []string, enrich DatamodelEnricher) error
  • func (R *Runtime) EnrichGenerators(generators []string, enrich GeneratorEnricher) error
  • func (R *Runtime) Load() (err error)
  • func (R *Runtime) OutputDir(dir string) string
• type RuntimeStats
  • func (S *RuntimeStats) String() string

Types

type DatamodelEnricher

type DatamodelEnricher func(*Runtime, *datamodel.Datamodel) error

type GeneratorEnricher

type GeneratorEnricher func(*Runtime, *gen.Generator) error

type Runtime

type Runtime struct {
	sync.Mutex

	// original flags used to load the CUE
	Flags flags.RootPflagpole

	// Other important dirs when loading templates (auto set)
	WorkingDir    string
	CueModuleRoot string
	RootToCwd     string // module root -> working dir (foo/bar)
	CwdToRoot     string // module root <- working dir (../..)
	// OutputDir     string  // where gen wants to write (tbd, other commands too)
	OriginalWkdir string // when we need to cd and then output back to this directory (create related, but could expand)

	// CUE related fields
	Entrypoints    []string
	CueContext     *cue.Context
	CueConfig      *load.Config
	BuildInstances []*build.Instance
	CueErrors      []error
	FieldOpts      []cue.Option

	// The CUE value after all loading
	Value cue.Value

	// we need to rethink how we organize the code
	// in each of these packages so we can separate
	// the commands from the types and core logic
	Nodes      []*hof.Node[any]
	Datamodels []*datamodel.Datamodel
	Generators []*gen.Generator

	Stats *RuntimeStats
	// contains filtered or unexported fields
}

This is the hof Runtime that backs most commands

func New

func New(entrypoints []string, rflags flags.RootPflagpole) (*Runtime, error)

func (*Runtime) EnrichDatamodels

func (R *Runtime) EnrichDatamodels(datamodels []string, enrich DatamodelEnricher) error

func (*Runtime) EnrichGenerators

func (R *Runtime) EnrichGenerators(generators []string, enrich GeneratorEnricher) error

func (*Runtime) Load

func (R *Runtime) Load() (err error)

func (*Runtime) OutputDir

func (R *Runtime) OutputDir(dir string) string

OutputDir returns the absolute path to output dir for this runtime. It accounts for module root and relative directories.

type RuntimeStats

type RuntimeStats struct {
	CueLoadingTime time.Duration
	GenLoadingTime time.Duration
	GenRunningTime time.Duration
}

func (*RuntimeStats) String

func (S *RuntimeStats) String() string