runner

Documentation

Index

• Constants
• func FindModRootFrom(startPath string) (string, *reporter.KpmEvent)
• func GetKclVersion() string
• type Compiler
  • func DefaultCompiler() *Compiler
  • func NewCompilerWithOpts(opts *opt.CompileOptions) *Compiler
  • func (compiler *Compiler) AddDepPath(depName string, depPath string) *Compiler
  • func (compiler *Compiler) AddKFile(kFilePath string) *Compiler
  • func (compiler *Compiler) AddKclOption(opt kcl.Option) *Compiler
  • func (compiler *Compiler) Run() (*kcl.KCLResultList, error)
• type Entry
  • func FindRunEntryFrom(sources []string) (*Entry, *reporter.KpmEvent)
  • func (e *Entry) AddEntryFile(entrySource string)
  • func (e *Entry) EntryFiles() []string
  • func (e *Entry) IsEmpty() bool
  • func (e *Entry) IsGit() bool
  • func (e *Entry) IsLocalFile() bool
  • func (e *Entry) IsLocalFileWithKclMod() bool
  • func (e *Entry) IsRef() bool
  • func (e *Entry) IsTar() bool
  • func (e *Entry) IsUrl() bool
  • func (e *Entry) Kind() EntryKind
  • func (e *Entry) PackageSource() string
  • func (e *Entry) SetKind(kind EntryKind)
  • func (e *Entry) SetPackageSource(packageSource string)
• type EntryKind
  • func GetSourceKindFrom(source string) EntryKind

Constants

const EXTERNAL_PKGS_ARG_PATTERN = "%s=%s"

The pattern of the external package argument.

Functions

func FindModRootFrom

func FindModRootFrom(startPath string) (string, *reporter.KpmEvent)

FindModRootFrom will find the kcl.mod path from the start path.

func GetKclVersion

func GetKclVersion() string

GetKclVersion fetches the kcl version

Types

type Compiler

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

Compiler is a wrapper of kcl compiler.

func DefaultCompiler

func DefaultCompiler() *Compiler

DefaultCompiler will create a default compiler.

func NewCompilerWithOpts

func NewCompilerWithOpts(opts *opt.CompileOptions) *Compiler

func (*Compiler) AddDepPath

func (compiler *Compiler) AddDepPath(depName string, depPath string) *Compiler

AddDep will add a file path to the dependency list.

func (*Compiler) AddKFile

func (compiler *Compiler) AddKFile(kFilePath string) *Compiler

AddKFile will add a k file to the compiler.

func (*Compiler) AddKclOption

func (compiler *Compiler) AddKclOption(opt kcl.Option) *Compiler

AddKclOption will add a kcl option to the compiler.

func (*Compiler) Run

func (compiler *Compiler) Run() (*kcl.KCLResultList, error)

Call KCL Compiler and return the result.

type Entry

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

Entry is the entry of 'kpm run'.

func FindRunEntryFrom

func FindRunEntryFrom(sources []string) (*Entry, *reporter.KpmEvent)

FindRunEntryFrom will find the entry of the compilation from the entry sources.

func (*Entry) AddEntryFile

func (e *Entry) AddEntryFile(entrySource string)

AddEntryFile will add a entry file to the entry.

func (*Entry) EntryFiles

func (e *Entry) EntryFiles() []string

EntryFiles will return the entry files of the entry.

func (*Entry) IsEmpty

func (e *Entry) IsEmpty() bool

IsEmpty will return true if the entry is empty.

func (*Entry) IsGit

func (e *Entry) IsGit() bool

func (*Entry) IsLocalFile

func (e *Entry) IsLocalFile() bool

IsLocalFile will return true if the entry is a local file.

func (*Entry) IsLocalFileWithKclMod

func (e *Entry) IsLocalFileWithKclMod() bool

IsLocalFileWithKclMod will return true if the entry is a local file with 'kcl.mod'.

func (*Entry) IsRef

func (e *Entry) IsRef() bool

IsRef will return true if the entry is a ref.

func (*Entry) IsTar

func (e *Entry) IsTar() bool

IsTar will return true if the entry is a tar.

func (*Entry) IsUrl

func (e *Entry) IsUrl() bool

IsUrl will return true if the entry is a url.

func (*Entry) Kind

func (e *Entry) Kind() EntryKind

Kind will return the kind of the entry.

func (*Entry) PackageSource

func (e *Entry) PackageSource() string

PackageSource will return the package source of the entry.

func (*Entry) SetKind

func (e *Entry) SetKind(kind EntryKind)

SetKind will set the kind of the entry.

func (*Entry) SetPackageSource

func (e *Entry) SetPackageSource(packageSource string)

SetPackageSource will set the package source of the entry.

type EntryKind

type EntryKind string

EntryKind is the kind of the entry. Including: 1. WithKclMod: local file which can find 'kcl.mod' in the parent dir of the file. 2. WithoutKclMod: local file which can find 'kcl.mod' in the parent dir of the file. 3. TarEntry: kcl package tar file. 4. UrlEntry: kcl package url. 5. RefEntry: kcl package ref.

func GetSourceKindFrom

func GetSourceKindFrom(source string) EntryKind

GetSourceKindFrom will return the kind of the source.