display

Documentation

Index

• Constants
• func ClearCurrentLine()
• func ColumnNames(columns []*sql.ColumnType) []string
• func ColumnValueAsString(val interface{}, colType *sql.ColumnType) (result string, err error)
• func ColumnValuesAsString(values []interface{}, columns []*sql.ColumnType) ([]string, error)
• func ParseJSONOutputColumnValue(val interface{}, colType *sql.ColumnType) (interface{}, error)
• func PrintInstallReports(reports []InstallReport, isUpdateReport bool)
• func ShowOutput(result *queryresult.Result)
• func ShowPaged(content string)
• func ShowSpinner(msg string) *spinner.Spinner
• func ShowWrappedTable(headers []string, rows [][]string, autoMerge bool)
• func StartSpinnerAfterDelay(msg string, delay time.Duration, cancelStartIf chan bool) *spinner.Spinner
• func StopSpinner(spinner *spinner.Spinner)
• func StopSpinnerWithMessage(spinner *spinner.Spinner, finalMsg string)
• func UpdateSpinnerMessage(spinner *spinner.Spinner, newMessage string)
• type InstallReport
  • func (i *InstallReport) String() string

Constants

const ALREADY_INSTALLED = "Already installed"

const LATEST_ALREADY_INSTALLED = "Latest already installed"

const NOT_INSTALLED = "Not installed"

Functions

func ClearCurrentLine

func ClearCurrentLine()

func ColumnNames

func ColumnNames(columns []*sql.ColumnType) []string

ColumnNames :: extract names from columns

func ColumnValueAsString

func ColumnValueAsString(val interface{}, colType *sql.ColumnType) (result string, err error)

ColumnValueAsString :: convert column value to string

func ColumnValuesAsString

func ColumnValuesAsString(values []interface{}, columns []*sql.ColumnType) ([]string, error)

ColumnValuesAsString :: converts a slice of columns into strings

func ParseJSONOutputColumnValue

func ParseJSONOutputColumnValue(val interface{}, colType *sql.ColumnType) (interface{}, error)

segregate data types, ignore string conversion for certain data types : JSON, JSONB, BOOL and so on..

func PrintInstallReports

func PrintInstallReports(reports []InstallReport, isUpdateReport bool)

Prints out the installation reports onto the console

func ShowOutput

func ShowOutput(result *queryresult.Result)

ShowOutput :: displays the output using the proper formatter as applicable

func ShowPaged

func ShowPaged(content string)

ShowPaged :: displays the `content` in a system dependent pager

func ShowSpinner

func ShowSpinner(msg string) *spinner.Spinner

ShowSpinner shows a spinner with the given message

func ShowWrappedTable

func ShowWrappedTable(headers []string, rows [][]string, autoMerge bool)

func StartSpinnerAfterDelay

func StartSpinnerAfterDelay(msg string, delay time.Duration, cancelStartIf chan bool) *spinner.Spinner

StartSpinnerAfterDelay shows the spinner with the given `msg` if and only if `cancelStartIf` resolves after `delay`.

Example: if delay is 2 seconds and `cancelStartIf` resolves after 2.5 seconds, the spinner will show for 0.5 seconds. If `cancelStartIf` resolves after 1.5 seconds, the spinner will NOT be shown at all

func StopSpinner

func StopSpinner(spinner *spinner.Spinner)

StopSpinner stops a spinner instance and clears it

func StopSpinnerWithMessage

func StopSpinnerWithMessage(spinner *spinner.Spinner, finalMsg string)

StopSpinnerWithMessage stops a spinner instance and clears it, after writing `finalMsg`

func UpdateSpinnerMessage

func UpdateSpinnerMessage(spinner *spinner.Spinner, newMessage string)

UpdateSpinnerMessage updates the message of the given spinner

Types

type InstallReport

type InstallReport struct {
	Skipped        bool
	Plugin         string
	SkipReason     string
	DocURL         string
	Version        string
	IsUpdateReport bool
}

func (*InstallReport) String

func (i *InstallReport) String() string