log

package

v0.0.138 Latest Latest Go to latest Published: Dec 31, 2025 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/tensorleap/leap-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ConnectFileToVerboseLogOutput(filePath string) (close func(), err error)
func Error(args ...interface{})
func Errorf(format string, args ...interface{})
func Fatalf(format string, args ...interface{})
func Fatalln(args ...interface{})
func GetLevel() logrus.Level
func Info(args ...interface{})
func Infof(format string, args ...interface{})
func InteractiveSelectTea(onInputChange OnInputChange, onEnter OnEnter, onTabKey OnTabKey) (string, error)
func Printf(format string, args ...interface{})
func Println(args ...interface{})
func Warn(args ...interface{})
func Warnf(format string, args ...interface{})
type Job
type LoggerWriters
- func NewLoggerOutputs(logger *logrus.Logger) *LoggerWriters
- func (lw *LoggerWriters) Add(w io.Writer)
- func (lw *LoggerWriters) Remove(w io.Writer)
- func (lw *LoggerWriters) Set()
type OnEnter
type OnInputChange
type OnTabKey
type ProgressReader
- func NewProgressReader(reader io.Reader, totalSize int64, updateFunc func(percent int)) *ProgressReader
- func (pr *ProgressReader) Read(p []byte) (int, error)
type Renderer
- func NewRenderer() *Renderer
- func (r *Renderer) Start()
- func (r *Renderer) Stop()
- func (r *Renderer) Update(steps []Step)
type Spinner
- func NewSpinner(message string, a ...any) *Spinner
- func (sp *Spinner) Start()
- func (sp *Spinner) Stop()
- func (sp *Spinner) UpdateProgress(percent int)
type Step
type StepStatus

Constants ¶

View Source

const FrameDuration = time.Millisecond * 100 // 10 frame per second

Variables ¶

View Source

var VerboseLogger = (*logrus.Logger)(nil)

View Source

var VerboseLoggerOutputs = (*LoggerWriters)(nil)

Functions ¶

func ConnectFileToVerboseLogOutput ¶

func ConnectFileToVerboseLogOutput(filePath string) (close func(), err error)

func Error ¶

func Error(args ...interface{})

func Errorf ¶

func Errorf(format string, args ...interface{})

func Fatalf ¶

func Fatalf(format string, args ...interface{})

func Fatalln ¶

func Fatalln(args ...interface{})

func GetLevel ¶ added in v0.0.32

func GetLevel() logrus.Level

func Info ¶

func Info(args ...interface{})

func Infof ¶

func Infof(format string, args ...interface{})

func InteractiveSelectTea ¶ added in v0.0.129

func InteractiveSelectTea(onInputChange OnInputChange, onEnter OnEnter, onTabKey OnTabKey) (string, error)

--------------------------- Public API ---------------------------

func Printf ¶

func Printf(format string, args ...interface{})

func Println ¶

func Println(args ...interface{})

func Warn ¶

func Warn(args ...interface{})

func Warnf ¶

func Warnf(format string, args ...interface{})

Types ¶

type Job ¶ added in v0.0.122

type Job struct {
	ID    string
	Steps []Step
}

type LoggerWriters ¶

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

func NewLoggerOutputs ¶

func NewLoggerOutputs(logger *logrus.Logger) *LoggerWriters

func (*LoggerWriters) Add ¶

func (lw *LoggerWriters) Add(w io.Writer)

func (*LoggerWriters) Remove ¶

func (lw *LoggerWriters) Remove(w io.Writer)

func (*LoggerWriters) Set ¶

func (lw *LoggerWriters) Set()

type OnEnter ¶ added in v0.0.129

type OnEnter func(options []string, cursor int, filter string) (selectedOption *string, newFilter string, inputErr string, hint string)

type OnInputChange ¶ added in v0.0.129

type OnInputChange func(cursor int, filter string) (title string, options []string, newCursor int, inputErr string, hint string)

--------------------------- Callback interface (same) ---------------------------

type OnTabKey ¶ added in v0.0.129

type OnTabKey func(options []string, cursor int, filter string) (newFilter string)

type ProgressReader ¶ added in v0.0.86

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

func NewProgressReader ¶ added in v0.0.86

func NewProgressReader(reader io.Reader, totalSize int64, updateFunc func(percent int)) *ProgressReader

func (*ProgressReader) Read ¶ added in v0.0.86

func (pr *ProgressReader) Read(p []byte) (int, error)

Read reads from the underlying reader and updates the progress.

type Renderer ¶ added in v0.0.122

type Renderer struct {
	IsTTY bool
	// contains filtered or unexported fields
}

func NewRenderer ¶ added in v0.0.122

func NewRenderer() *Renderer

NewRenderer automatically picks TTY or log mode.

func (*Renderer) Start ¶ added in v0.0.122

func (r *Renderer) Start()

func (*Renderer) Stop ¶ added in v0.0.122

func (r *Renderer) Stop()

func (*Renderer) Update ¶ added in v0.0.122

func (r *Renderer) Update(steps []Step)

type Spinner ¶ added in v0.0.86

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

Spinner is a custom type that wraps a spinner with additional functionality.

func NewSpinner ¶ added in v0.0.22

func NewSpinner(message string, a ...any) *Spinner

NewSpinner creates a new Spinner instance with the specified message.

func (*Spinner) Start ¶ added in v0.0.86

func (sp *Spinner) Start()

Start begins the spinner animation.

func (*Spinner) Stop ¶ added in v0.0.86

func (sp *Spinner) Stop()

Stop stops the spinner animation and prints a completion message.

func (*Spinner) UpdateProgress ¶ added in v0.0.86

func (sp *Spinner) UpdateProgress(percent int)

UpdateProgress updates the progress percentage displayed with the spinner.

type Step ¶ added in v0.0.122

type Step struct {
	Name    string
	Status  StepStatus
	Current float64
	Total   float64
}

type StepStatus ¶ added in v0.0.122

type StepStatus string

const (
	StepStatusDone    StepStatus = "DONE"
	StepStatusFailed  StepStatus = "FAILED"
	StepStatusRunning StepStatus = "RUNNING"
	StepStatusPending StepStatus = "PENDING"
	StepStatusWaiting StepStatus = "WAITING"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL