cue

Documentation

Index

• Constants
• Variables
• func GetDefault(val cue.Value) interface{}
• func GetParameters(templateStr string, pd *packages.PackageDiscover) ([]types.Parameter, error)
• func IsFieldNotExist(err error) bool
• 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 ErrParameterNotExist = errors.New("parameter not exist")

ErrParameterNotExist represents the parameter field is not exist in CUE template

Functions

func GetDefault

func GetDefault(val cue.Value) interface{}

GetDefault evaluate default Go value from CUE

func GetParameters

func GetParameters(templateStr string, pd *packages.PackageDiscover) ([]types.Parameter, error)

GetParameters get parameter from cue template

func IsFieldNotExist

func IsFieldNotExist(err error) bool

IsFieldNotExist check whether the error type is the field not found

func RetrieveComments

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

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