cue

README

Develop Tips

The following packages need to be tested without external/tool dependencies, So that the cue-sh/unity can do verification

• github.com/oam-dev/kubevela/pkg/cue/definition
• github.com/oam-dev/kubevela/pkg/cue/model
• github.com/oam-dev/kubevela/pkg/cue/model/sets
• github.com/oam-dev/kubevela/pkg/cue/process
• github.com/oam-dev/kubevela/pkg/cue/task
• github.com/oam-dev/kubevela/pkg/cue/packages

Documentation

Index

• Constants
• Variables
• func GetDefault(val cue.Value) interface{}
• func GetParameters(templateStr string) ([]types.Parameter, error)
• func IntifyValues(raw interface{}) interface{}
• func RetrieveComments(value cue.Value) (string, string, string, bool)

Constants

const (
	// UsagePrefix defines the usage display for KubeVela CLI
	UsagePrefix = "+usage="
	// ShortPrefix defines the short argument for KubeVela CLI
	ShortPrefix = "+short="
	// AliasPrefix is an alias of the name of a parameter element, in order to making it more friendly to Cli users
	AliasPrefix = "+alias="
	// IgnorePrefix defines parameter in system level which we don't want our end user to see for KubeVela CLI
	IgnorePrefix = "+ignore"
)

const BaseTemplate = `

context: {
  name: string
  config?: [...{
    name: string
    value: string
  }]
}
`

BaseTemplate include base info provided by KubeVela for CUE template

Variables

var ParameterTag = "parameter"

ParameterTag is the keyword in CUE template to define users' input

Functions

func GetDefault

func GetDefault(val cue.Value) interface{}

GetDefault evaluate default Go value from CUE

func GetParameters

func GetParameters(templateStr string) ([]types.Parameter, error)

GetParameters get parameter from cue template

func IntifyValues

func IntifyValues(raw interface{}) interface{}

IntifyValues will make values to int. JSON marshalling of user values will put integer into float, we have to change it back so that CUE check will succeed.

func RetrieveComments

func RetrieveComments(value cue.Value) (string, string, string, bool)

RetrieveComments will retrieve Usage, Short, Alias and Ignore from CUE Value