cue

Documentation

Index

• func Generate(p *Package, options ...GenerateOption) error
• type GenerateOption
  • func WithLayout(layout bool) GenerateOption
• type Package
  • func ParsePackage(root string, options ...ParseOption) (*Package, error)
  • func (pkg *Package) Manifest() *rmsV1.Manifest
• type ParseOption
• type Plan
  • func GeneratePlan(p *Package, options ...GenerateOption) (*Plan, error)
  • func (plan *Plan) Pretty() error
  • func (plan *Plan) Save() error

Functions

func Generate

func Generate(p *Package, options ...GenerateOption) error

Generate will generate code files into the output folder

Types

type GenerateOption

type GenerateOption func(*generator) error

GenerateOption is a function that configures a generator.

func WithLayout

func WithLayout(layout bool) GenerateOption

WithLayout will set the layout option

type Package

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

Package is a package written by CUE.

func ParsePackage

func ParsePackage(root string, options ...ParseOption) (*Package, error)

ParsePackage parses the package.

func (*Package) Manifest

func (pkg *Package) Manifest() *rmsV1.Manifest

Manifest returns the resource management specification of the package.

type ParseOption

type ParseOption func(*parser) error

ParseOption is a function that configures a parser.

type Plan

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

func GeneratePlan

func GeneratePlan(p *Package, options ...GenerateOption) (*Plan, error)

GeneratePlan will generate a plan for generating code files into the output folder

func (*Plan) Pretty

func (plan *Plan) Pretty() error

Pretty prints the plan to stdout

func (*Plan) Save

func (plan *Plan) Save() error

Save saves the plan to the output folder