Documentation
¶
Index ¶
- Constants
- Variables
- func AltScreen()deprecated
- func ChangeScrollingRegion(top, bottom int)deprecated
- func ClearLine()deprecated
- func ClearLineLeft()deprecated
- func ClearLineRight()deprecated
- func ClearLines(n int)deprecated
- func ClearScreen()deprecated
- func ConvertToRGB(c Color) colorful.Color
- func Copy(str string)
- func CopyPrimary(str string)
- func CursorBack(n int)deprecated
- func CursorDown(n int)deprecated
- func CursorForward(n int)deprecated
- func CursorNextLine(n int)deprecated
- func CursorPrevLine(n int)deprecated
- func CursorUp(n int)deprecated
- func DeleteLines(n int)deprecated
- func DisableBracketedPaste()deprecated
- func DisableMouse()deprecated
- func DisableMouseAllMotion()deprecated
- func DisableMouseCellMotion()deprecated
- func DisableMouseHilite()deprecated
- func DisableMousePress()deprecated
- func EnableBracketedPaste()deprecated
- func EnableMouse()deprecated
- func EnableMouseAllMotion()deprecated
- func EnableMouseCellMotion()deprecated
- func EnableMouseHilite()deprecated
- func EnableMousePress()deprecated
- func EnableVirtualTerminalProcessing(o *Output) (restoreFunc func() error, err error)
- func EnableWindowsANSIConsole() (uint32, error)
- func EnvNoColor() bool
- func ExitAltScreen()deprecated
- func HasDarkBackground() bool
- func HideCursor()deprecated
- func Hyperlink(link, name string) string
- func InsertLines(n int)deprecated
- func MoveCursor(row int, column int)deprecated
- func Notify(title, body string)
- func Reset()deprecated
- func RestoreCursorPosition()deprecated
- func RestoreScreen()deprecated
- func RestoreWindowsConsole(mode uint32) error
- func SaveCursorPosition()deprecated
- func SaveScreen()deprecated
- func SetBackgroundColor(color Color)deprecated
- func SetCursorColor(color Color)deprecated
- func SetDefaultOutput(o *Output)
- func SetForegroundColor(color Color)deprecated
- func SetWindowTitle(title string)deprecated
- func ShowCursor()deprecated
- func TemplateFuncs(p Profile) template.FuncMap
- type ANSI256Color
- type ANSIColor
- type Color
- type Environ
- type Filedeprecated
- type NoColor
- type Output
- func (o Output) AltScreen()
- func (o *Output) BackgroundColor() Color
- func (o Output) ChangeScrollingRegion(top, bottom int)
- func (o Output) ClearLine()
- func (o Output) ClearLineLeft()
- func (o Output) ClearLineRight()
- func (o Output) ClearLines(n int)
- func (o Output) ClearScreen()
- func (o *Output) ColorProfile() Profile
- func (o Output) Copy(str string)
- func (o Output) CopyPrimary(str string)
- func (o Output) CursorBack(n int)
- func (o Output) CursorDown(n int)
- func (o Output) CursorForward(n int)
- func (o Output) CursorNextLine(n int)
- func (o Output) CursorPrevLine(n int)
- func (o Output) CursorUp(n int)
- func (o Output) DeleteLines(n int)
- func (o Output) DisableBracketedPaste()
- func (o Output) DisableMouse()
- func (o Output) DisableMouseAllMotion()
- func (o Output) DisableMouseCellMotion()
- func (o Output) DisableMouseExtendedMode()
- func (o Output) DisableMouseHilite()
- func (o Output) DisableMousePixelsMode()
- func (o Output) DisableMousePress()
- func (o Output) EnableBracketedPaste()
- func (o Output) EnableMouse()
- func (o Output) EnableMouseAllMotion()
- func (o Output) EnableMouseCellMotion()
- func (o Output) EnableMouseExtendedMode()
- func (o Output) EnableMouseHilite()
- func (o Output) EnableMousePixelsMode()
- func (o Output) EnableMousePress()
- func (o *Output) EnvColorProfile() Profile
- func (o *Output) EnvNoColor() bool
- func (o Output) ExitAltScreen()
- func (o *Output) ForegroundColor() Color
- func (o *Output) HasDarkBackground() bool
- func (o Output) HideCursor()
- func (o *Output) Hyperlink(link, name string) string
- func (o Output) InsertLines(n int)
- func (o Output) MoveCursor(row int, column int)
- func (o *Output) Notify(title, body string)
- func (o Output) Reset()
- func (o Output) RestoreCursorPosition()
- func (o Output) RestoreScreen()
- func (o Output) SaveCursorPosition()
- func (o Output) SaveScreen()
- func (o Output) SetBackgroundColor(color Color)
- func (o Output) SetCursorColor(color Color)
- func (o Output) SetForegroundColor(color Color)
- func (o Output) SetWindowTitle(title string)
- func (o Output) ShowCursor()
- func (o Output) TTY() Filedeprecated
- func (o Output) TemplateFuncs() template.FuncMap
- func (o Output) Write(p []byte) (int, error)
- func (o Output) WriteString(s string) (int, error)
- func (o Output) Writer() io.Writer
- type OutputOption
- type Profile
- type RGBColor
- type Style
- func (t Style) Background(c Color) Style
- func (t Style) Blink() Style
- func (t Style) Bold() Style
- func (t Style) CrossOut() Style
- func (t Style) Faint() Style
- func (t Style) Foreground(c Color) Style
- func (t Style) Italic() Style
- func (t Style) Overline() Style
- func (t Style) Reverse() Style
- func (t Style) String() string
- func (t Style) Styled(s string) string
- func (t Style) StyledWithoutReset(s string) string
- func (t Style) Underline() Style
- func (t Style) Width() int
Constants ¶
const ( Foreground = "38" Background = "48" )
Foreground and Background sequence codes.
const ( // TrueColor, 24-bit color profile. TrueColor = Profile(iota) // ANSI256, 8-bit color profile. ANSI256 // ANSI, 4-bit color profile. ANSI // Ascii, uncolored profile. Ascii //nolint:revive )
const ( // Cursor positioning. CursorUpSeq = "%dA" CursorDownSeq = "%dB" CursorForwardSeq = "%dC" CursorBackSeq = "%dD" CursorNextLineSeq = "%dE" CursorPreviousLineSeq = "%dF" CursorHorizontalSeq = "%dG" CursorPositionSeq = "%d;%dH" EraseDisplaySeq = "%dJ" EraseLineSeq = "%dK" ScrollUpSeq = "%dS" ScrollDownSeq = "%dT" SaveCursorPositionSeq = "s" RestoreCursorPositionSeq = "u" ChangeScrollingRegionSeq = "%d;%dr" InsertLineSeq = "%dL" DeleteLineSeq = "%dM" // Explicit values for EraseLineSeq. EraseLineRightSeq = "0K" EraseLineLeftSeq = "1K" EraseEntireLineSeq = "2K" // Mouse. EnableMousePressSeq = "?9h" // press only (X10) DisableMousePressSeq = "?9l" EnableMouseSeq = "?1000h" // press, release, wheel DisableMouseSeq = "?1000l" EnableMouseHiliteSeq = "?1001h" // highlight DisableMouseHiliteSeq = "?1001l" EnableMouseCellMotionSeq = "?1002h" // press, release, move on pressed, wheel DisableMouseCellMotionSeq = "?1002l" EnableMouseAllMotionSeq = "?1003h" // press, release, move, wheel DisableMouseAllMotionSeq = "?1003l" EnableMouseExtendedModeSeq = "?1006h" // press, release, move, wheel, extended coordinates DisableMouseExtendedModeSeq = "?1006l" EnableMousePixelsModeSeq = "?1016h" // press, release, move, wheel, extended pixel coordinates DisableMousePixelsModeSeq = "?1016l" // Screen. RestoreScreenSeq = "?47l" SaveScreenSeq = "?47h" AltScreenSeq = "?1049h" ExitAltScreenSeq = "?1049l" // Bracketed paste. // https://en.wikipedia.org/wiki/Bracketed-paste EnableBracketedPasteSeq = "?2004h" DisableBracketedPasteSeq = "?2004l" StartBracketedPasteSeq = "200~" EndBracketedPasteSeq = "201~" // Session. SetWindowTitleSeq = "2;%s" + string(BEL) SetForegroundColorSeq = "10;%s" + string(BEL) SetBackgroundColorSeq = "11;%s" + string(BEL) SetCursorColorSeq = "12;%s" + string(BEL) ShowCursorSeq = "?25h" HideCursorSeq = "?25l" )
Sequence definitions.
const ( ResetSeq = "0" BoldSeq = "1" FaintSeq = "2" ItalicSeq = "3" UnderlineSeq = "4" BlinkSeq = "5" ReverseSeq = "7" CrossOutSeq = "9" OverlineSeq = "53" )
Sequence definitions.
Variables ¶
var ErrInvalidColor = errors.New("invalid color")
ErrInvalidColor gets returned when a color is invalid.
var ( // ErrStatusReport gets returned when the terminal can't be queried. ErrStatusReport = errors.New("unable to retrieve status report") )
Functions ¶
func AltScreen
deprecated
func AltScreen()
AltScreen switches to the alternate screen buffer. The former view can be restored with ExitAltScreen().
Deprecated: please use termenv.Output instead.
func ChangeScrollingRegion
deprecated
func ChangeScrollingRegion(top, bottom int)
ChangeScrollingRegion sets the scrolling region of the terminal.
Deprecated: please use termenv.Output instead.
func ClearLine
deprecated
func ClearLine()
ClearLine clears the current line.
Deprecated: please use termenv.Output instead.
func ClearLineLeft
deprecated
func ClearLineLeft()
ClearLineLeft clears the line to the left of the cursor.
Deprecated: please use termenv.Output instead.
func ClearLineRight
deprecated
func ClearLineRight()
ClearLineRight clears the line to the right of the cursor.
Deprecated: please use termenv.Output instead.
func ClearLines
deprecated
func ClearLines(n int)
ClearLines clears a given number of lines.
Deprecated: please use termenv.Output instead.
func ClearScreen
deprecated
func ClearScreen()
ClearScreen clears the visible portion of the terminal.
Deprecated: please use termenv.Output instead.
func ConvertToRGB ¶
ConvertToRGB converts a Color to a colorful.Color.
func CopyPrimary ¶
func CopyPrimary(str string)
CopyPrimary copies text to primary clipboard (X11) using OSC 52 escape sequence.
func CursorBack
deprecated
func CursorBack(n int)
CursorBack moves the cursor backwards a given number of cells.
Deprecated: please use termenv.Output instead.
func CursorDown
deprecated
func CursorDown(n int)
CursorDown moves the cursor down a given number of lines.
Deprecated: please use termenv.Output instead.
func CursorForward
deprecated
func CursorForward(n int)
CursorForward moves the cursor up a given number of lines.
Deprecated: please use termenv.Output instead.
func CursorNextLine
deprecated
func CursorNextLine(n int)
CursorNextLine moves the cursor down a given number of lines and places it at the beginning of the line.
Deprecated: please use termenv.Output instead.
func CursorPrevLine
deprecated
func CursorPrevLine(n int)
CursorPrevLine moves the cursor up a given number of lines and places it at the beginning of the line.
Deprecated: please use termenv.Output instead.
func DeleteLines
deprecated
func DeleteLines(n int)
DeleteLines deletes the given number of lines, pulling any lines in the scrollable region below up.
Deprecated: please use termenv.Output instead.
func DisableBracketedPaste
deprecated
func DisableBracketedPaste()
DisableBracketedPaste disables bracketed paste.
Deprecated: please use termenv.Output instead.
func DisableMouse
deprecated
func DisableMouse()
DisableMouse disables Mouse Tracking mode.
Deprecated: please use termenv.Output instead.
func DisableMouseAllMotion
deprecated
func DisableMouseAllMotion()
DisableMouseAllMotion disables All Motion Mouse mode.
Deprecated: please use termenv.Output instead.
func DisableMouseCellMotion
deprecated
func DisableMouseCellMotion()
DisableMouseCellMotion disables Cell Motion Mouse Tracking mode.
Deprecated: please use termenv.Output instead.
func DisableMouseHilite
deprecated
func DisableMouseHilite()
DisableMouseHilite disables Hilite Mouse Tracking mode.
Deprecated: please use termenv.Output instead.
func DisableMousePress
deprecated
func DisableMousePress()
DisableMousePress disables X10 mouse mode.
Deprecated: please use termenv.Output instead.
func EnableBracketedPaste
deprecated
func EnableBracketedPaste()
EnableBracketedPaste enables bracketed paste.
Deprecated: please use termenv.Output instead.
func EnableMouse
deprecated
func EnableMouse()
EnableMouse enables Mouse Tracking mode.
Deprecated: please use termenv.Output instead.
func EnableMouseAllMotion
deprecated
func EnableMouseAllMotion()
EnableMouseAllMotion enables All Motion Mouse mode.
Deprecated: please use termenv.Output instead.
func EnableMouseCellMotion
deprecated
func EnableMouseCellMotion()
EnableMouseCellMotion enables Cell Motion Mouse Tracking mode.
Deprecated: please use termenv.Output instead.
func EnableMouseHilite
deprecated
func EnableMouseHilite()
EnableMouseHilite enables Hilite Mouse Tracking mode.
Deprecated: please use termenv.Output instead.
func EnableMousePress
deprecated
func EnableMousePress()
EnableMousePress enables X10 mouse mode. Button press events are sent only.
Deprecated: please use termenv.Output instead.
func EnableVirtualTerminalProcessing ¶
EnableVirtualTerminalProcessing enables virtual terminal processing on Windows for o and returns a function that restores o to its previous state. On non-Windows platforms, or if o does not refer to a terminal, then it returns a non-nil no-op function and no error.
func EnableWindowsANSIConsole ¶
EnableWindowsANSIConsole enables virtual terminal processing on Windows platforms. This allows the use of ANSI escape sequences in Windows console applications. Ensure this gets called before anything gets rendered with termenv.
Returns the original console mode and an error if one occurred.
func EnvNoColor ¶
func EnvNoColor() bool
EnvNoColor returns true if the environment variables explicitly disable color output by setting NO_COLOR (https://no-color.org/) or CLICOLOR/CLICOLOR_FORCE (https://bixense.com/clicolors/) If NO_COLOR is set, this will return true, ignoring CLICOLOR/CLICOLOR_FORCE If CLICOLOR=="0", it will be true only if CLICOLOR_FORCE is also "0" or is unset.
func ExitAltScreen
deprecated
func ExitAltScreen()
ExitAltScreen exits the alternate screen buffer and returns to the former terminal view.
Deprecated: please use termenv.Output instead.
func HasDarkBackground ¶
func HasDarkBackground() bool
HasDarkBackground returns whether terminal uses a dark-ish background.
func HideCursor
deprecated
func HideCursor()
HideCursor hides the cursor.
Deprecated: please use termenv.Output instead.
func InsertLines
deprecated
func InsertLines(n int)
InsertLines inserts the given number of lines at the top of the scrollable region, pushing lines below down.
Deprecated: please use termenv.Output instead.
func MoveCursor
deprecated
func Reset
deprecated
func Reset()
Reset the terminal to its default style, removing any active styles.
Deprecated: please use termenv.Output instead.
func RestoreCursorPosition
deprecated
func RestoreCursorPosition()
RestoreCursorPosition restores a saved cursor position.
Deprecated: please use termenv.Output instead.
func RestoreScreen
deprecated
func RestoreScreen()
RestoreScreen restores a previously saved screen state.
Deprecated: please use termenv.Output instead.
func RestoreWindowsConsole ¶
RestoreWindowsConsole restores the console mode to a previous state.
func SaveCursorPosition
deprecated
func SaveCursorPosition()
SaveCursorPosition saves the cursor position.
Deprecated: please use termenv.Output instead.
func SaveScreen
deprecated
func SaveScreen()
SaveScreen saves the screen state.
Deprecated: please use termenv.Output instead.
func SetBackgroundColor
deprecated
func SetBackgroundColor(color Color)
SetBackgroundColor sets the default background color.
Deprecated: please use termenv.Output instead.
func SetCursorColor
deprecated
func SetCursorColor(color Color)
SetCursorColor sets the cursor color.
Deprecated: please use termenv.Output instead.
func SetDefaultOutput ¶
func SetDefaultOutput(o *Output)
SetDefaultOutput sets the default global output.
func SetForegroundColor
deprecated
func SetForegroundColor(color Color)
SetForegroundColor sets the default foreground color.
Deprecated: please use termenv.Output instead.
func SetWindowTitle
deprecated
func SetWindowTitle(title string)
SetWindowTitle sets the terminal window title.
Deprecated: please use termenv.Output instead.
func ShowCursor
deprecated
func ShowCursor()
ShowCursor shows the cursor.
Deprecated: please use termenv.Output instead.
func TemplateFuncs ¶
TemplateFuncs contains a few useful template helpers.
Types ¶
type ANSI256Color ¶
type ANSI256Color int
ANSI256Color is a color (16-255) as defined by the ANSI Standard.
func (ANSI256Color) Sequence ¶
func (c ANSI256Color) Sequence(bg bool) string
Sequence returns the ANSI Sequence for the color.
func (ANSI256Color) String ¶
func (c ANSI256Color) String() string
type ANSIColor ¶
type ANSIColor int
ANSIColor is a color (0-15) as defined by the ANSI Standard.
const ( ANSIBlack ANSIColor = iota ANSIRed ANSIGreen ANSIYellow ANSIBlue ANSIMagenta ANSICyan ANSIWhite ANSIBrightBlack ANSIBrightRed ANSIBrightGreen ANSIBrightYellow ANSIBrightBlue ANSIBrightMagenta ANSIBrightCyan ANSIBrightWhite )
ANSI color codes.
type Color ¶
type Color interface {
// Sequence returns the ANSI Sequence for the color.
Sequence(bg bool) string
}
Color is an interface implemented by all colors that can be converted to an ANSI sequence.
func BackgroundColor ¶
func BackgroundColor() Color
BackgroundColor returns the terminal's default background color.
func ForegroundColor ¶
func ForegroundColor() Color
ForegroundColor returns the terminal's default foreground color.
type File
deprecated
type File interface {
io.ReadWriter
Fd() uintptr
}
File represents a file descriptor.
Deprecated: Use *os.File instead.
type NoColor ¶
type NoColor struct{}
NoColor is a nop for terminals that don't support colors.
type Output ¶
type Output struct {
Profile
// contains filtered or unexported fields
}
Output is a terminal output.
func NewOutput ¶
func NewOutput(w io.Writer, opts ...OutputOption) *Output
NewOutput returns a new Output for the given writer.
func (Output) AltScreen ¶
func (o Output) AltScreen()
AltScreen switches to the alternate screen buffer. The former view can be restored with ExitAltScreen().
func (*Output) BackgroundColor ¶
BackgroundColor returns the terminal's default background color.
func (Output) ChangeScrollingRegion ¶
ChangeScrollingRegion sets the scrolling region of the terminal.
func (Output) ClearLineLeft ¶
func (o Output) ClearLineLeft()
ClearLineLeft clears the line to the left of the cursor.
func (Output) ClearLineRight ¶
func (o Output) ClearLineRight()
ClearLineRight clears the line to the right of the cursor.
func (Output) ClearLines ¶
ClearLines clears a given number of lines.
func (Output) ClearScreen ¶
func (o Output) ClearScreen()
ClearScreen clears the visible portion of the terminal.
func (*Output) ColorProfile ¶
func (Output) CopyPrimary ¶
CopyPrimary copies text to primary clipboard (X11) using OSC 52 escape sequence.
func (Output) CursorBack ¶
CursorBack moves the cursor backwards a given number of cells.
func (Output) CursorDown ¶
CursorDown moves the cursor down a given number of lines.
func (Output) CursorForward ¶
CursorForward moves the cursor up a given number of lines.
func (Output) CursorNextLine ¶
CursorNextLine moves the cursor down a given number of lines and places it at the beginning of the line.
func (Output) CursorPrevLine ¶
CursorPrevLine moves the cursor up a given number of lines and places it at the beginning of the line.
func (Output) DeleteLines ¶
DeleteLines deletes the given number of lines, pulling any lines in the scrollable region below up.
func (Output) DisableBracketedPaste ¶
func (o Output) DisableBracketedPaste()
DisableBracketedPaste disables bracketed paste.
func (Output) DisableMouse ¶
func (o Output) DisableMouse()
DisableMouse disables Mouse Tracking mode.
func (Output) DisableMouseAllMotion ¶
func (o Output) DisableMouseAllMotion()
DisableMouseAllMotion disables All Motion Mouse mode.
func (Output) DisableMouseCellMotion ¶
func (o Output) DisableMouseCellMotion()
DisableMouseCellMotion disables Cell Motion Mouse Tracking mode.
func (Output) DisableMouseExtendedMode ¶
func (o Output) DisableMouseExtendedMode()
DisableMouseExtendedMotion disables Extended Mouse mode (SGR).
func (Output) DisableMouseHilite ¶
func (o Output) DisableMouseHilite()
DisableMouseHilite disables Hilite Mouse Tracking mode.
func (Output) DisableMousePixelsMode ¶
func (o Output) DisableMousePixelsMode()
DisableMousePixelsMotion disables Pixel Motion Mouse mode (SGR-Pixels).
func (Output) DisableMousePress ¶
func (o Output) DisableMousePress()
DisableMousePress disables X10 mouse mode.
func (Output) EnableBracketedPaste ¶
func (o Output) EnableBracketedPaste()
EnableBracketedPaste enables bracketed paste.
func (Output) EnableMouseAllMotion ¶
func (o Output) EnableMouseAllMotion()
EnableMouseAllMotion enables All Motion Mouse mode.
func (Output) EnableMouseCellMotion ¶
func (o Output) EnableMouseCellMotion()
EnableMouseCellMotion enables Cell Motion Mouse Tracking mode.
func (Output) EnableMouseExtendedMode ¶
func (o Output) EnableMouseExtendedMode()
EnableMouseExtendedMotion enables Extended Mouse mode (SGR). This should be enabled in conjunction with EnableMouseCellMotion, and EnableMouseAllMotion.
func (Output) EnableMouseHilite ¶
func (o Output) EnableMouseHilite()
EnableMouseHilite enables Hilite Mouse Tracking mode.
func (Output) EnableMousePixelsMode ¶
func (o Output) EnableMousePixelsMode()
EnableMousePixelsMotion enables Pixel Motion Mouse mode (SGR-Pixels). This should be enabled in conjunction with EnableMouseCellMotion, and EnableMouseAllMotion.
func (Output) EnableMousePress ¶
func (o Output) EnableMousePress()
EnableMousePress enables X10 mouse mode. Button press events are sent only.
func (*Output) EnvColorProfile ¶
EnvColorProfile returns the color profile based on environment variables set Supports NO_COLOR (https://no-color.org/) and CLICOLOR/CLICOLOR_FORCE (https://bixense.com/clicolors/) If none of these environment variables are set, this behaves the same as ColorProfile() It will return the Ascii color profile if EnvNoColor() returns true If the terminal does not support any colors, but CLICOLOR_FORCE is set and not "0" then the ANSI color profile will be returned.
func (*Output) EnvNoColor ¶
EnvNoColor returns true if the environment variables explicitly disable color output by setting NO_COLOR (https://no-color.org/) or CLICOLOR/CLICOLOR_FORCE (https://bixense.com/clicolors/) If NO_COLOR is set, this will return true, ignoring CLICOLOR/CLICOLOR_FORCE If CLICOLOR=="0", it will be true only if CLICOLOR_FORCE is also "0" or is unset.
func (Output) ExitAltScreen ¶
func (o Output) ExitAltScreen()
ExitAltScreen exits the alternate screen buffer and returns to the former terminal view.
func (*Output) ForegroundColor ¶
ForegroundColor returns the terminal's default foreground color.
func (*Output) HasDarkBackground ¶
HasDarkBackground returns whether terminal uses a dark-ish background.
func (Output) InsertLines ¶
InsertLines inserts the given number of lines at the top of the scrollable region, pushing lines below down.
func (Output) MoveCursor ¶
MoveCursor moves the cursor to a given position.
func (Output) Reset ¶
func (o Output) Reset()
Reset the terminal to its default style, removing any active styles.
func (Output) RestoreCursorPosition ¶
func (o Output) RestoreCursorPosition()
RestoreCursorPosition restores a saved cursor position.
func (Output) RestoreScreen ¶
func (o Output) RestoreScreen()
RestoreScreen restores a previously saved screen state.
func (Output) SaveCursorPosition ¶
func (o Output) SaveCursorPosition()
SaveCursorPosition saves the cursor position.
func (Output) SetBackgroundColor ¶
SetBackgroundColor sets the default background color.
func (Output) SetCursorColor ¶
SetCursorColor sets the cursor color.
func (Output) SetForegroundColor ¶
SetForegroundColor sets the default foreground color.
func (Output) SetWindowTitle ¶
SetWindowTitle sets the terminal window title.
func (Output) TemplateFuncs ¶
TemplateFuncs returns template helpers for the given output.
func (Output) WriteString ¶
WriteString writes the given string to the output.
type OutputOption ¶
type OutputOption = func(*Output)
OutputOption sets an option on Output.
func WithColorCache ¶
func WithColorCache(v bool) OutputOption
WithColorCache returns a new OutputOption with fore- and background color values pre-fetched and cached.
func WithEnvironment ¶
func WithEnvironment(environ Environ) OutputOption
WithEnvironment returns a new OutputOption for the given environment.
func WithProfile ¶
func WithProfile(profile Profile) OutputOption
WithProfile returns a new OutputOption for the given profile.
func WithTTY ¶
func WithTTY(v bool) OutputOption
WithTTY returns a new OutputOption to assume whether or not the output is a TTY. This is useful when mocking console output.
func WithUnsafe ¶
func WithUnsafe() OutputOption
WithUnsafe returns a new OutputOption with unsafe mode enabled. Unsafe mode doesn't check whether or not the terminal is a TTY.
This option supersedes WithTTY.
This is useful when mocking console output and enforcing ANSI escape output e.g. on SSH sessions.
type Profile ¶
type Profile int
Profile is a color profile: Ascii, ANSI, ANSI256, or TrueColor.
func ColorProfile ¶
func ColorProfile() Profile
ColorProfile returns the supported color profile: Ascii, ANSI, ANSI256, or TrueColor.
func EnvColorProfile ¶
func EnvColorProfile() Profile
EnvColorProfile returns the color profile based on environment variables set Supports NO_COLOR (https://no-color.org/) and CLICOLOR/CLICOLOR_FORCE (https://bixense.com/clicolors/) If none of these environment variables are set, this behaves the same as ColorProfile() It will return the Ascii color profile if EnvNoColor() returns true If the terminal does not support any colors, but CLICOLOR_FORCE is set and not "0" then the ANSI color profile will be returned.
func (Profile) Color ¶
Color creates a Color from a string. Valid inputs are hex colors, as well as ANSI color codes (0-15, 16-255).
type Style ¶
type Style struct {
// contains filtered or unexported fields
}
Style is a string that various rendering styles can be applied to.
func (Style) Background ¶
Background sets a background color.
func (Style) Foreground ¶
Foreground sets a foreground color.
func (Style) StyledWithoutReset ¶
Styled renders s with all applied styles, but no trailing reset
