kcl

Documentation

Overview

Package kcl defines the top-level interface for KCL.

Index

• func GetSchemaType(file, code, schemaName string) ([]*gpyrpc.KclType, error)
• func GetSchemaTypeMapping(file, code, schemaName string) (map[string]*gpyrpc.KclType, error)
• type KCLResult
  • func (m KCLResult) Get(key string, target ...interface{}) interface{}
  • func (m KCLResult) GetValue(key string, target ...interface{}) (value interface{}, err error)
  • func (m KCLResult) JSONString() string
  • func (m KCLResult) YAMLString() string
• type KCLResultList
  • func MustRun(path string, opts ...Option) *KCLResultList
  • func Run(path string, opts ...Option) (*KCLResultList, error)
  • func RunFiles(paths []string, opts ...Option) (*KCLResultList, error)
  • func RunWithOpts(opts ...Option) (*KCLResultList, error)
  • func (p *KCLResultList) First() KCLResult
  • func (p *KCLResultList) Get(i int) KCLResult
  • func (p *KCLResultList) GetPyEscapedTime() string
  • func (p *KCLResultList) GetRawJsonResult() string
  • func (p *KCLResultList) GetRawYamlResult() string
  • func (p *KCLResultList) Len() int
  • func (p *KCLResultList) Slice() []KCLResult
  • func (p *KCLResultList) Tail() KCLResult
• type KclType
• type Option
  • func NewOption() *Option
  • func ParseArgs(pathList []string, opts ...Option) (Option, error)
  • func WithCode(codes ...string) Option
  • func WithDisableNone(disableNone bool) Option
  • func WithExternalPkgs(key_value_list ...string) Option
  • func WithIncludeSchemaTypePath(includeSchemaTypePath bool) Option
  • func WithKFilenames(filenames ...string) Option
  • func WithOptions(key_value_list ...string) Option
  • func WithOverrides(override_list ...string) Option
  • func WithPrintOverridesAST(printOverrideAst bool) Option
  • func WithSettings(filename string) Option
  • func WithSortKeys(sortKeys bool) Option
  • func WithWorkDir(s string) Option
  • func (p *Option) JSONString() string
  • func (p *Option) Merge(opts ...Option) *Option

Functions

func GetSchemaType

func GetSchemaType(file, code, schemaName string) ([]*gpyrpc.KclType, error)

func GetSchemaTypeMapping

func GetSchemaTypeMapping(file, code, schemaName string) (map[string]*gpyrpc.KclType, error)

Types

type KCLResult

type KCLResult map[string]interface{}

func (KCLResult) Get

func (m KCLResult) Get(key string, target ...interface{}) interface{}

func (KCLResult) GetValue

func (m KCLResult) GetValue(key string, target ...interface{}) (value interface{}, err error)

func (KCLResult) JSONString

func (m KCLResult) JSONString() string

func (KCLResult) YAMLString

func (m KCLResult) YAMLString() string

type KCLResultList

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

func MustRun

func MustRun(path string, opts ...Option) *KCLResultList

func Run

func Run(path string, opts ...Option) (*KCLResultList, error)

func RunFiles

func RunFiles(paths []string, opts ...Option) (*KCLResultList, error)

func RunWithOpts

func RunWithOpts(opts ...Option) (*KCLResultList, error)

RunWithOpts is the same as Run, but it does not require a path as input. Note: you need to specify the path in options by method WithKFilenameList() or the workdir in method WorkDir(), or it will return an error.

func (*KCLResultList) First

func (p *KCLResultList) First() KCLResult

func (*KCLResultList) Get

func (p *KCLResultList) Get(i int) KCLResult

func (*KCLResultList) GetPyEscapedTime

func (p *KCLResultList) GetPyEscapedTime() string

func (*KCLResultList) GetRawJsonResult

func (p *KCLResultList) GetRawJsonResult() string

func (*KCLResultList) GetRawYamlResult

func (p *KCLResultList) GetRawYamlResult() string

func (*KCLResultList) Len

func (p *KCLResultList) Len() int

func (*KCLResultList) Slice

func (p *KCLResultList) Slice() []KCLResult

func (*KCLResultList) Tail

func (p *KCLResultList) Tail() KCLResult

type KclType

type KclType = gpyrpc.KclType

type Option

type Option struct {
	*gpyrpc.ExecProgram_Args
	Err error
}

func NewOption

func NewOption() *Option

NewOption returns a new Option.

func ParseArgs

func ParseArgs(pathList []string, opts ...Option) (Option, error)

func WithCode

func WithCode(codes ...string) Option

func WithDisableNone

func WithDisableNone(disableNone bool) Option

kcl -n --disable_none

func WithExternalPkgs

func WithExternalPkgs(key_value_list ...string) Option

kcl -E aaa=/xx/xxx/aaa main.k

func WithIncludeSchemaTypePath

func WithIncludeSchemaTypePath(includeSchemaTypePath bool) Option

WithIncludeSchemaTypePath returns a Option which hold a include schema type path switch.

func WithKFilenames

func WithKFilenames(filenames ...string) Option

func WithOptions

func WithOptions(key_value_list ...string) Option

kcl -D aa=11 -D bb=22 main.k

func WithOverrides

func WithOverrides(override_list ...string) Option

kcl -O pkgpath:path.to.field=field_value

func WithPrintOverridesAST

func WithPrintOverridesAST(printOverrideAst bool) Option

func WithSettings

func WithSettings(filename string) Option

kcl -Y settings.yaml

func WithSortKeys

func WithSortKeys(sortKeys bool) Option

kcl -k --sort_keys

func WithWorkDir

func WithWorkDir(s string) Option

func (*Option) JSONString

func (p *Option) JSONString() string

func (*Option) Merge

func (p *Option) Merge(opts ...Option) *Option

Merge will merge all options into one.