compile

Documentation

Overview

Provide general KCL compilation method

Index

• Constants
• func CompileUsingCmd(sourceKclFiles []string, targetFile string, args map[string]string, ...) (string, string, error)
• func CompileWithSpinner(workDir string, filenames, settings, arguments, overrides []string, ...) (*models.Spec, *pterm.SpinnerPrinter, error)
• func EnableRPC() bool
• func GetKclPath() string
• func GetKclvmPath() string
• func Init() error
• func Overwrite(fileName string, overrides []string) (bool, error)
• type CompileResult
  • func Compile(workDir string, filenames, settings, arguments, overrides []string, ...) (*CompileResult, error)
  • func NewCompileResult(k *kcl.KCLResultList) *CompileResult
  • func NewCompileResultByMapList(mapList []map[string]interface{}) *CompileResult
  • func (c *CompileResult) RawYAML() string

Constants

const KusionKclPathEnv = "KUSION_KCL_PATH"

Functions

func CompileUsingCmd

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

Simply call kcl cmd

func CompileWithSpinner

func CompileWithSpinner(workDir string, filenames, settings, arguments, overrides []string,
	stack *projectstack.Stack,
) (*models.Spec, *pterm.SpinnerPrinter, error)

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 Compile

func Compile(workDir string, filenames, settings, arguments, overrides []string, disableNone bool, overrideAST bool) (*CompileResult, error)

Compile General KCL compilation method

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 (*CompileResult) RawYAML

func (c *CompileResult) RawYAML() string