checker

Documentation

Index

• type Checker
• type IdentChecker
  • func NewIdentChecker() *IdentChecker
  • func (ic *IdentChecker) Check(kclPkg pkg.KclPkg) error
• type ModChecker
  • func NewModChecker(options ...ModCheckerOption) *ModChecker
  • func (mc *ModChecker) AddChecker(checker Checker)
  • func (mc *ModChecker) Check(kclPkg pkg.KclPkg) error
  • func (mc *ModChecker) CheckersSize() int
• type ModCheckerOption
  • func WithChecker(checker Checker) ModCheckerOption
  • func WithCheckers(checkers ...Checker) ModCheckerOption
• type SumChecker
  • func NewSumChecker(options ...SumCheckerOption) *SumChecker
  • func (sc *SumChecker) Check(kclPkg pkg.KclPkg) error
  • func (sc *SumChecker) FetchOciManifestIntoJsonStr(opts opt.OciFetchOptions) (string, error)
  • func (sc *SumChecker) GetCredentials(hostName string) (*remoteauth.Credential, error)
• type SumCheckerOption
  • func WithSettings(settings settings.Settings) SumCheckerOption
• type VersionChecker
  • func NewVersionChecker() *VersionChecker
  • func (vc *VersionChecker) Check(kclPkg pkg.KclPkg) error

Types

type Checker

type Checker interface {
	Check(pkg.KclPkg) error
}

Checker defines an interface for checking KclPkg dependencies.

type IdentChecker

type IdentChecker struct{}

IdentChecker validates the dependencies name in kclPkg.

func NewIdentChecker

func NewIdentChecker() *IdentChecker

NewIdentChecker creates a new IdentChecker.

func (*IdentChecker) Check

func (ic *IdentChecker) Check(kclPkg pkg.KclPkg) error

type ModChecker

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

ModChecker is responsible for running multiple checkers on a KCL module.

func NewModChecker

func NewModChecker(options ...ModCheckerOption) *ModChecker

NewModChecker creates a new ModChecker with options.

func (*ModChecker) AddChecker

func (mc *ModChecker) AddChecker(checker Checker)

func (*ModChecker) Check

func (mc *ModChecker) Check(kclPkg pkg.KclPkg) error

Check runs all individual checks for a kclPkg.

func (*ModChecker) CheckersSize

func (mc *ModChecker) CheckersSize() int

type ModCheckerOption

type ModCheckerOption func(*ModChecker)

ModCheckerOption configures how we set up ModChecker.

func WithChecker

func WithChecker(checker Checker) ModCheckerOption

WithChecker adds a single Checker to ModChecker.

func WithCheckers

func WithCheckers(checkers ...Checker) ModCheckerOption

WithCheckers adds multiple Checkers to ModChecker.

type SumChecker

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

SumChecker validates the dependencies sum in kclPkg.

func NewSumChecker

func NewSumChecker(options ...SumCheckerOption) *SumChecker

NewSumChecker creates a new SumChecker with options.

func (*SumChecker) Check

func (sc *SumChecker) Check(kclPkg pkg.KclPkg) error

Check verifies the checksums of the dependencies in the KclPkg.

func (*SumChecker) FetchOciManifestIntoJsonStr

func (sc *SumChecker) FetchOciManifestIntoJsonStr(opts opt.OciFetchOptions) (string, error)

FetchOciManifestIntoJsonStr fetches the OCI manifest and returns it as a JSON string.

func (*SumChecker) GetCredentials

func (sc *SumChecker) GetCredentials(hostName string) (*remoteauth.Credential, error)

GetCredentials retrieves the OCI credentials for the given hostname.

type SumCheckerOption

type SumCheckerOption func(*SumChecker)

SumCheckerOption configures how we set up SumChecker.

func WithSettings

func WithSettings(settings settings.Settings) SumCheckerOption

WithSettings sets the settings for SumChecker.

type VersionChecker

type VersionChecker struct{}

VersionChecker validates the dependencies version in kclPkg.

func NewVersionChecker

func NewVersionChecker() *VersionChecker

NewVersionChecker creates a new VersionChecker.

func (*VersionChecker) Check

func (vc *VersionChecker) Check(kclPkg pkg.KclPkg) error