iostreams

package
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 12, 2025 License: MIT Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	NoTheme    = "none"
	DarkTheme  = "dark"
	LightTheme = "light"
)
View Source 
const DefaultWidth = 80

Variables

This section is empty.

Functions

This section is empty.

Types

type ColorScheme 

type ColorScheme struct {
	// Enabled is whether color is used at all.
	Enabled bool
	// EightBitColor is whether the terminal supports 8-bit, 256 colors.
	EightBitColor bool
	// TrueColor is whether the terminal supports 24-bit, 16 million colors.
	TrueColor bool
	// Accessible is whether colors must be base 16 colors that users can customize in terminal preferences.
	Accessible bool
	// ColorLabels is whether labels are colored based on their truecolor RGB hex color.
	ColorLabels bool
	// Theme is the terminal background color theme used to contextually color text for light, dark, or none at all.
	Theme string
}

ColorScheme controls how text is colored based upon terminal capabilities and user preferences.

func (*ColorScheme) Blue 

func (c *ColorScheme) Blue(t string) string

func (*ColorScheme) Bluef 

func (c *ColorScheme) Bluef(t string, args ...interface{}) string

func (*ColorScheme) Bold 

func (c *ColorScheme) Bold(t string) string

func (*ColorScheme) Boldf 

func (c *ColorScheme) Boldf(t string, args ...interface{}) string

func (*ColorScheme) ColorFromString 

func (c *ColorScheme) ColorFromString(s string) func(string) string

func (*ColorScheme) Cyan 

func (c *ColorScheme) Cyan(t string) string

func (*ColorScheme) CyanBold 

func (c *ColorScheme) CyanBold(t string) string

func (*ColorScheme) Cyanf 

func (c *ColorScheme) Cyanf(t string, args ...interface{}) string

func (*ColorScheme) FailureIcon 

func (c *ColorScheme) FailureIcon() string

func (*ColorScheme) FailureIconWithColor 

func (c *ColorScheme) FailureIconWithColor(colo func(string) string) string

func (*ColorScheme) Gray deprecated 

func (c *ColorScheme) Gray(t string) string

Deprecated: Use Muted instead for thematically contrasting color.

func (*ColorScheme) Grayf deprecated 

func (c *ColorScheme) Grayf(t string, args ...interface{}) string

Deprecated: Use Mutedf instead for thematically contrasting color.

func (*ColorScheme) Green 

func (c *ColorScheme) Green(t string) string

func (*ColorScheme) GreenBold 

func (c *ColorScheme) GreenBold(t string) string

func (*ColorScheme) Greenf 

func (c *ColorScheme) Greenf(t string, args ...interface{}) string

func (*ColorScheme) Highlight 

func (c *ColorScheme) Highlight(t string) string

func (*ColorScheme) HighlightStart 

func (c *ColorScheme) HighlightStart() string

func (*ColorScheme) Label 

func (c *ColorScheme) Label(hex string, x string) string

Label stylizes text based on label's RGB hex color.

func (*ColorScheme) Magenta 

func (c *ColorScheme) Magenta(t string) string

func (*ColorScheme) Magentaf 

func (c *ColorScheme) Magentaf(t string, args ...interface{}) string

func (*ColorScheme) Muted 

func (c *ColorScheme) Muted(t string) string

func (*ColorScheme) Mutedf 

func (c *ColorScheme) Mutedf(t string, args ...interface{}) string

func (*ColorScheme) Red 

func (c *ColorScheme) Red(t string) string

func (*ColorScheme) Redf 

func (c *ColorScheme) Redf(t string, args ...interface{}) string

func (*ColorScheme) Reset 

func (c *ColorScheme) Reset() string

func (*ColorScheme) SuccessIcon 

func (c *ColorScheme) SuccessIcon() string

func (*ColorScheme) SuccessIconWithColor 

func (c *ColorScheme) SuccessIconWithColor(colo func(string) string) string

func (*ColorScheme) TableHeader 

func (c *ColorScheme) TableHeader(t string) string

func (*ColorScheme) WarningIcon 

func (c *ColorScheme) WarningIcon() string

func (*ColorScheme) Yellow 

func (c *ColorScheme) Yellow(t string) string

func (*ColorScheme) Yellowf 

func (c *ColorScheme) Yellowf(t string, args ...interface{}) string

type ErrClosedPagerPipe 

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

ErrClosedPagerPipe is the error returned when writing to a pager that has been closed.

type IOStreams 

type IOStreams struct {
	In     fileReader
	Out    fileWriter
	ErrOut fileWriter

	TempFileOverride *os.File
	// contains filtered or unexported fields
}

func System 

func System() *IOStreams

func Test 

func Test() (*IOStreams, *bytes.Buffer, *bytes.Buffer, *bytes.Buffer)

func (*IOStreams) AccessibleColorsEnabled 

func (s *IOStreams) AccessibleColorsEnabled() bool

func (*IOStreams) AccessiblePrompterEnabled 

func (s *IOStreams) AccessiblePrompterEnabled() bool

func (*IOStreams) CanPrompt 

func (s *IOStreams) CanPrompt() bool

func (*IOStreams) ColorEnabled 

func (s *IOStreams) ColorEnabled() bool

func (*IOStreams) ColorLabels 

func (s *IOStreams) ColorLabels() bool

func (*IOStreams) ColorScheme 

func (s *IOStreams) ColorScheme() *ColorScheme

func (*IOStreams) ColorSupport256 

func (s *IOStreams) ColorSupport256() bool

func (*IOStreams) DetectTerminalTheme 

func (s *IOStreams) DetectTerminalTheme()

DetectTerminalTheme is a utility to call before starting the output pager so that the terminal background can be reliably detected.

func (*IOStreams) GetNeverPrompt 

func (s *IOStreams) GetNeverPrompt() bool

func (*IOStreams) GetPager 

func (s *IOStreams) GetPager() string

func (*IOStreams) GetSpinnerDisabled 

func (s *IOStreams) GetSpinnerDisabled() bool

func (*IOStreams) HasTrueColor 

func (s *IOStreams) HasTrueColor() bool

func (*IOStreams) IsStderrTTY 

func (s *IOStreams) IsStderrTTY() bool

func (*IOStreams) IsStdinTTY 

func (s *IOStreams) IsStdinTTY() bool

func (*IOStreams) IsStdoutTTY 

func (s *IOStreams) IsStdoutTTY() bool

func (*IOStreams) ReadUserFile 

func (s *IOStreams) ReadUserFile(fn string) ([]byte, error)

func (*IOStreams) RefreshScreen 

func (s *IOStreams) RefreshScreen()

func (*IOStreams) RunWithProgress 

func (s *IOStreams) RunWithProgress(label string, run func() error) error

func (*IOStreams) SetAccessibleColorsEnabled 

func (s *IOStreams) SetAccessibleColorsEnabled(enabled bool)

func (*IOStreams) SetAccessiblePrompterEnabled 

func (s *IOStreams) SetAccessiblePrompterEnabled(enabled bool)

func (*IOStreams) SetAlternateScreenBufferEnabled 

func (s *IOStreams) SetAlternateScreenBufferEnabled(enabled bool)

func (*IOStreams) SetColorEnabled 

func (s *IOStreams) SetColorEnabled(colorEnabled bool)

func (*IOStreams) SetColorLabels 

func (s *IOStreams) SetColorLabels(colorLabels bool)

func (*IOStreams) SetNeverPrompt 

func (s *IOStreams) SetNeverPrompt(v bool)

func (*IOStreams) SetPager 

func (s *IOStreams) SetPager(cmd string)

func (*IOStreams) SetSpinnerDisabled 

func (s *IOStreams) SetSpinnerDisabled(v bool)

func (*IOStreams) SetStderrTTY 

func (s *IOStreams) SetStderrTTY(isTTY bool)

func (*IOStreams) SetStdinTTY 

func (s *IOStreams) SetStdinTTY(isTTY bool)

func (*IOStreams) SetStdoutTTY 

func (s *IOStreams) SetStdoutTTY(isTTY bool)

func (*IOStreams) StartAlternateScreenBuffer 

func (s *IOStreams) StartAlternateScreenBuffer()

func (*IOStreams) StartPager 

func (s *IOStreams) StartPager() error

func (*IOStreams) StartProgressIndicator 

func (s *IOStreams) StartProgressIndicator()

func (*IOStreams) StartProgressIndicatorWithLabel 

func (s *IOStreams) StartProgressIndicatorWithLabel(label string)

func (*IOStreams) StopAlternateScreenBuffer 

func (s *IOStreams) StopAlternateScreenBuffer()

func (*IOStreams) StopPager 

func (s *IOStreams) StopPager()

func (*IOStreams) StopProgressIndicator 

func (s *IOStreams) StopProgressIndicator()

StopProgressIndicator stops the progress indicator if it is running. Note that a textual progess indicator does not create a progress indicator, so this method is a no-op in that case.

func (*IOStreams) TempFile 

func (s *IOStreams) TempFile(dir, pattern string) (*os.File, error)

func (*IOStreams) TerminalTheme 

func (s *IOStreams) TerminalTheme() string

TerminalTheme returns "light", "dark", or "none" depending on the background color of the terminal.

func (*IOStreams) TerminalWidth 

func (s *IOStreams) TerminalWidth() int

TerminalWidth returns the width of the terminal that controls the process

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.