kcl

Documentation

Index

• Constants
• func BuildOptions(workDir string, settings, arguments, overrides []string, ...) ([]kcl.Option, error)
• func CompileUsingCmd(sourceKclFiles []string, targetFile string, args map[string]string, ...) (string, string, error)
• func EnableRPC() bool
• func GetKclPath() string
• func GetKclvmPath() string
• func Init() error
• func Overwrite(fileName string, overrides []string) (bool, error)
• type CompileResult
  • func NewCompileResult(k *kcl.KCLResultList) *CompileResult
  • func NewCompileResultByMapList(mapList []map[string]interface{}) *CompileResult
  • func Run(o *generator.Options, stack *projectstack.Stack) (*CompileResult, error)
  • func (c *CompileResult) RawYAML() string
• type Generator
  • func (g *Generator) GenerateSpec(o *generator.Options, stack *projectstack.Stack) (*models.Spec, error)

Constants

const (
	KusionKclPathEnv = "KUSION_KCL_PATH"
	ID               = "id"
	Type             = "type"
	Attributes       = "attributes"
)

Functions

func BuildOptions

func BuildOptions(workDir string, settings, arguments, overrides []string, disableNone, overrideAST bool) ([]kcl.Option, error)

func CompileUsingCmd

func CompileUsingCmd(sourceKclFiles []string, targetFile string, args map[string]string, settings []string) (string, string, error)

Simply call kcl cmd

func EnableRPC

func EnableRPC() bool

func GetKclPath

func GetKclPath() string

Get kcl cli path

func GetKclvmPath

func GetKclvmPath() string

Get kclvm cli path

func Init

func Init() error

func Overwrite

func Overwrite(fileName string, overrides []string) (bool, error)

Types

type CompileResult

type CompileResult struct {
	Documents     []kcl.KCLResult
	RawYAMLResult string
}

The result of a KCL compilation

func NewCompileResult

func NewCompileResult(k *kcl.KCLResultList) *CompileResult

New a CompileResult by KCLResultList

func NewCompileResultByMapList

func NewCompileResultByMapList(mapList []map[string]interface{}) *CompileResult

New a CompileResult by map array

func Run

func Run(o *generator.Options, stack *projectstack.Stack) (*CompileResult, error)

func (*CompileResult) RawYAML

func (c *CompileResult) RawYAML() string

type Generator

type Generator struct{}

func (*Generator) GenerateSpec

func (g *Generator) GenerateSpec(o *generator.Options, stack *projectstack.Stack) (*models.Spec, error)