api

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 16, 2024 License: Apache-2.0 Imports: 17 Imported by: 9

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetKclPkgPath added in v0.3.4 

func GetKclPkgPath() (string, error)

GetKclPkgPath will return the value of $KCL_PKG_PATH.

If $KCL_PKG_PATH does not exist, it will return '$HOME/.kcl/kpm' by default.

func IsSchema added in v0.3.4 

func IsSchema(kt *KclType) bool

IsSchema returns true if the type is schema.

func IsSchemaInstance added in v0.3.4 

func IsSchemaInstance(kt *KclType) bool

IsSchemaInstance returns true if the type is schema instance.

func IsSchemaNamed added in v0.3.4 

func IsSchemaNamed(kt *KclType, name string) bool

IsSchemaNamed returns true if the type is schema and the name is equal to the given name.

func IsSchemaType added in v0.3.4 

func IsSchemaType(kt *KclType) bool

IsSchemaType returns true if the type is schema type.

func RunCurrentPkg added in v0.3.5 

func RunCurrentPkg(opts *opt.CompileOptions) (*kcl.KCLResultList, error)

RunCurrentPkg will compile the current kcl package.

func RunOci 

func RunOci(ociRef, version string, opts *opt.CompileOptions) (string, error)

RunOci will compile the kcl package from an OCI reference.

func RunOciPkg added in v0.3.5 

func RunOciPkg(ociRef, version string, opts *opt.CompileOptions) (*kcl.KCLResultList, error)

RunOciPkg will compile the kcl package from an OCI reference.

func RunPkg 

func RunPkg(opts *opt.CompileOptions) (string, error)

RunPkg will compile current kcl package.

func RunPkgInPath 

func RunPkgInPath(opts *opt.CompileOptions) (string, error)

RunPkgInPath will load the 'KclPkg' from path 'pkgPath'. And run the kcl package with entry file in 'entryFilePath' in 'vendorMode'.

func RunPkgWithOpt added in v0.3.5 

func RunPkgWithOpt(opts *opt.CompileOptions) (*kcl.KCLResultList, error)

RunPkgWithOpt will compile the kcl package with the compile options. Deprecated: This method will not be maintained in the future. Use RunWithOpts instead.

func RunTar 

func RunTar(tarPath string, opts *opt.CompileOptions) (string, error)

RunTar will compile the kcl package from a kcl package tar.

func RunTarPkg added in v0.3.5 

func RunTarPkg(tarPath string, opts *opt.CompileOptions) (*kcl.KCLResultList, error)

RunTarPkg will compile the kcl package from a kcl package tar.

func RunWithOpt added in v0.3.6 

func RunWithOpt(opts *opt.CompileOptions) (*kcl.KCLResultList, error)

CompileWithOpt will compile the kcl program without kcl package. Deprecated: This method will not be maintained in the future. Use RunWithOpts instead.

func RunWithOpts added in v0.4.5 

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

RunWithOpts will compile the kcl package with the compile options.

Types

type KclPackage added in v0.3.4 

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

The KCL Package

func GetKclPackage added in v0.3.4 

func GetKclPackage(pkgPath string) (*KclPackage, error)

GetKclPackage returns the kcl package infomation.

'pkgPath' is the root path of the package where the 'kcl.mod' is located in.

'kcl_pkg_path' is the path of dependencies download by kpm.

func (*KclPackage) ExportSwaggerV2Spec added in v0.9.4 

func (pkg *KclPackage) ExportSwaggerV2Spec() (*gen.SwaggerV2Spec, error)

ExportSwaggerV2Spec extracts the swagger v2 representation of a kcl package with external dependencies.

func (*KclPackage) GetAllSchemaTypeMapping added in v0.3.4 

func (pkg *KclPackage) GetAllSchemaTypeMapping() (map[string]map[string]*KclType, error)

GetAllSchemaTypeMapping returns all the schema types of the package.

It will return a map of schema types, the key is the relative path to the package home path.

And, the value is a map of schema types, the key is the schema name, the value is the schema type.

func (*KclPackage) GetDependencies added in v0.3.4 

func (pkg *KclPackage) GetDependencies() pkg.Dependencies

GetDependencies returns the dependencies of the package.

func (*KclPackage) GetDependenciesInModFile added in v0.8.3 

func (pkg *KclPackage) GetDependenciesInModFile() *pkg.Dependencies

GetDependenciesInModFile returns the mod file of the package.

func (*KclPackage) GetEdition added in v0.3.4 

func (pkg *KclPackage) GetEdition() string

GetPkgEdition returns the kcl compiler edition of the package.

func (*KclPackage) GetFullSchemaTypeMappingWithFilters added in v0.4.2 

func (pkg *KclPackage) GetFullSchemaTypeMappingWithFilters(kpmcli *client.KpmClient, filterFuncs []KclTypeFilterFunc) (map[string]map[string]*KclType, error)

GetFullSchemaTypeMappingWithFilters returns the full schema type filtered by the filter functions.

func (*KclPackage) GetPkgHomePath added in v0.3.4 

func (pkg *KclPackage) GetPkgHomePath() string

GetPkgHomePath returns the home path of the package.

func (*KclPackage) GetPkgName added in v0.3.4 

func (pkg *KclPackage) GetPkgName() string

GetPkgName returns the name of the package.

func (*KclPackage) GetPkgProfile added in v0.3.4 

func (pkg *KclPackage) GetPkgProfile() *pkg.Profile

GetPkgProfile returns the profile of the package.

func (*KclPackage) GetSchemaTypeMappingNamed added in v0.3.4 

func (pkg *KclPackage) GetSchemaTypeMappingNamed(schemaName string) (map[string]map[string]*KclType, error)

GetSchemaTypeMappingNamed returns the schema type filtered by schema name.

If 'schemaName' is empty, it will return all the schema types.

func (*KclPackage) GetSchemaTypeMappingWithFilters added in v0.3.4 

func (pkg *KclPackage) GetSchemaTypeMappingWithFilters(filterFuncs []KclTypeFilterFunc) (map[string]map[string]*KclType, error)

GetSchemaTypeMappingWithFilters returns the schema type filtered by the filter functions.

func (*KclPackage) GetVersion added in v0.3.4 

func (pkg *KclPackage) GetVersion() string

GetPkgVersion returns the version of the package.

func (*KclPackage) StoreModFile added in v0.8.7 

func (pkg *KclPackage) StoreModFile() error

StoreModFile stores the kcl.mod file of the package to local file system.

func (*KclPackage) StoreModLockFile added in v0.8.7 

func (pkg *KclPackage) StoreModLockFile() error

StoreModLockFile stores the kcl.mod.lock file of the package to local file system.

func (*KclPackage) UpdateDependencyInPath added in v0.3.4 

func (pkg *KclPackage) UpdateDependencyInPath(pkg_path string) error

UpdateDependencyInPath updates the dependencies in the path.

'pkg_path' is the path of dependencies download by kpm.

type KclType added in v0.3.4 

type KclType struct {
	Name    string
	RelPath string
	*gpyrpc.KclType
}

An additional field 'Name' is added to the original 'KclType'.

'Name' is the name of the kcl type.

'RelPath' is the relative path to the package home path.

func NewKclTypes added in v0.3.4 

func NewKclTypes(name, path string, tys *gpyrpc.KclType) *KclType

NewKclTypes returns a new KclType.

type KclTypeFilterFunc added in v0.3.4 

type KclTypeFilterFunc func(kt *KclType) bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.