ui

Documentation

Index

• type UI
  • func (ui *UI) Debug(err string)
  • func (ui *UI) Debugf(format string, a ...interface{})
  • func (ui *UI) Error(err string)
  • func (ui *UI) Errorf(format string, a ...interface{})
  • func (ui *UI) Fatal(err string)
  • func (ui *UI) Fatalf(format string, a ...interface{})
  • func (ui *UI) Info(err string)
  • func (ui *UI) Infof(format string, a ...interface{})
  • func (ui *UI) SetLogfile(file io.Writer)
  • func (ui *UI) SetPrettyPrint(enabled bool)
  • func (ui *UI) ShouldEnableDebug(enabled bool)
  • func (ui *UI) ShowResult()

Types

type UI

type UI struct {
	LogFile        io.Writer
	HostingEnabled bool
	Port           string

	PrettyLog    bool
	DebugEnabled bool
	// contains filtered or unexported fields
}

UI is the way to display stuff on the console.

func (*UI) Debug

func (ui *UI) Debug(err string)

Debug logs to the log file only

func (*UI) Debugf

func (ui *UI) Debugf(format string, a ...interface{})

Debugf logs to the log file only

func (*UI) Error

func (ui *UI) Error(err string)

Error logs errors, these can later be followed up on with a fatal or have potential consequences for the outcome

func (*UI) Errorf

func (ui *UI) Errorf(format string, a ...interface{})

Errorf logs errors, these can later be followed up on with a fatal or have potential consequences for the outcome

func (*UI) Fatal

func (ui *UI) Fatal(err string)

Fatal should be called when in an unrecoverable state. EG: config file not found, template function not called etc.

func (*UI) Fatalf

func (ui *UI) Fatalf(format string, a ...interface{})

Fatalf should be called when in an unrecoverable state. EG: config file not found, template function not called etc.

func (*UI) Info

func (ui *UI) Info(err string)

Info logs helpfull information/warnings

func (*UI) Infof

func (ui *UI) Infof(format string, a ...interface{})

Infof logs helpfull information/warnings

func (*UI) SetLogfile

func (ui *UI) SetLogfile(file io.Writer)

SetLogfile sets the output writer for the logger

func (*UI) SetPrettyPrint

func (ui *UI) SetPrettyPrint(enabled bool)

SetPrettyPrint this sets the setting for pretty printing,

func (*UI) ShouldEnableDebug

func (ui *UI) ShouldEnableDebug(enabled bool)

ShouldEnableDebug enables/disables debug logging (performance)

func (*UI) ShowResult

func (ui *UI) ShowResult()

ShowResult should be shown when something builds successfully