reporter

Documentation

Index

• func ExitWithReport(v ...any)
• func Fatal(v ...any)
• func InitReporter()
• func Report(v ...any)
• func ReportEventTo(event *KpmEvent, w io.Writer)
• func ReportEventToStderr(event *KpmEvent)
• func ReportEventToStdout(event *KpmEvent)
• func ReportMsgTo(msg string, w io.Writer)
• type Event
• type EventType
• type KpmEvent
  • func NewErrorEvent(errType EventType, err error, args ...string) *KpmEvent
  • func NewEvent(errType EventType, args ...string) *KpmEvent
  • func (e *KpmEvent) Error() string
  • func (e *KpmEvent) Event() string
  • func (e *KpmEvent) Type() EventType

Functions

func ExitWithReport

func ExitWithReport(v ...any)

ExitWithReport prints to the logger and exit with 0. Arguments are handled in the manner of fmt.Println.

func Fatal

func Fatal(v ...any)

Fatal prints to the logger and exit with 1. Arguments are handled in the manner of fmt.Println.

func InitReporter

func InitReporter()

Init the log.

func Report

func Report(v ...any)

Report prints to the logger. Arguments are handled in the manner of fmt.Println.

func ReportEventTo

func ReportEventTo(event *KpmEvent, w io.Writer)

ReportEvent reports the event to users to stdout.

func ReportEventToStderr

func ReportEventToStderr(event *KpmEvent)

ReportEventToStderr reports the event to users to stderr.

func ReportEventToStdout

func ReportEventToStdout(event *KpmEvent)

ReportEventToStdout reports the event to users to stdout.

func ReportMsgTo

func ReportMsgTo(msg string, w io.Writer)

Types

type Event

type Event interface {
	Event() string
}

Event is the interface that specifies the event used to show logs to users.

type EventType

type EventType int

const (
	Default EventType = iota

	// errors event type means the event is an error.
	InvalidRepo
	FailedNewOciClient
	RepoNotFound
	FailedLoadSettings
	FailedLoadCredential
	FailedCreateOciClient
	FailedSelectLatestVersion
	FailedGetPackageVersions
	FailedCreateStorePath
	FailedPush
	FailedGetPkg
	FailedVendor
	FailedAccessPkgPath
	UnKnownPullWhat
	UnknownEnv
	InvalidKclPkg
	FailedUntarKclPkg
	FailedLoadKclMod
	FailedLoadKclModLock
	FailedCreateFile
	FailedPackage
	FailedLogin
	FailedLogout
	FileExists
	CheckSumMismatch
	CalSumFailed
	InvalidKpmHomeInCurrentPkg
	InvalidCmd
	InvalidPkgRef
	InvalidGitUrl
	WithoutGitTag
	FailedCloneFromGit
	FailedHashPkg
	Bug

	// normal event type means the event is a normal event.
	PullingStarted
	PullingFinished
	Pulling
	InvalidFlag
	Adding
	WaitingLock
	IsNotUrl
	IsNotRef
	UrlSchemeNotOci
	UnsupportOciUrlScheme
	SelectLatestVersion
	DownloadingFromOCI
	DownloadingFromGit
	LocalPathNotExist
	PathIsEmpty
	ConflictPkgName
	AddItselfAsDep
	PkgTagExists
	DependencyNotFound
	CircularDependencyExist
	RemoveDep
	AddDep
	KclModNotFound
	CompileFailed
	FailedParseVersion
)

type KpmEvent

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

KpmEvent is the event used to show kpm logs to users.

func NewErrorEvent

func NewErrorEvent(errType EventType, err error, args ...string) *KpmEvent

NewErrorEvent returns a new KpmEvent with error.

func NewEvent

func NewEvent(errType EventType, args ...string) *KpmEvent

NewEvent returns a new KpmEvent without error.

func (*KpmEvent) Error

func (e *KpmEvent) Error() string

Error makes KpmEvent can be used as an error.

func (*KpmEvent) Event

func (e *KpmEvent) Event() string

Event returns the msg of the event without error message.

func (*KpmEvent) Type

func (e *KpmEvent) Type() EventType

Type returns the event type.