Affected by GO-2022-0395 and 4 other vulnerabilities

GO-2022-0395: GitHub CLI can execute a git binary from the current directory in github.com/cli/cli

GO-2024-3269: Connecting to a malicious Codespaces via GH CLI could allow command execution on the user's computer in github.com/cli/cli

GO-2024-3296: Recursive repository cloning can leak authentication tokens to non-GitHub submodule hosts in github.com/cli/cli

GO-2024-3310: Downloading malicious GitHub Actions workflow artifact results in path traversal vulnerability in github.com/cli/cli

GO-2025-3467: `gh attestation verify` returns incorrect exit code during verification if no attestations are present in github.com/cli/cli

The highest tagged major version is v2.

utils

package

v1.2.0 Latest Latest Go to latest Published: Oct 27, 2020 License: MIT Imports: 15 Imported by: 5

Details

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

Repository

github.com/cli/cli

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func DisplayURL(urlStr string) string
func FuzzyAgo(ago time.Duration) string
func GreenCheck() string
func Humanize(s string) string
func IsCygwinTerminal(f *os.File) bool
func IsURL(s string) bool
func NewColorable(w io.Writer) io.Writer
func OpenInBrowser(url string) error
func Pluralize(num int, thing string) string
func RedX() string
func Spinner(w io.Writer) *spinner.Spinner
func YellowDash() string
type TablePrinter
- func NewTablePrinter(io *iostreams.IOStreams) TablePrinter

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Outputs ANSI color if stdout is a tty
	Magenta = makeColorFunc("magenta")
	Cyan    = makeColorFunc("cyan")
	Red     = makeColorFunc("red")
	Yellow  = makeColorFunc("yellow")
	Blue    = makeColorFunc("blue")
	Green   = makeColorFunc("green")
	Gray    = makeColorFunc("black+h")
	Bold    = makeColorFunc("default+b")
)

View Source

var IsTerminal = func(f *os.File) bool {
	return isatty.IsTerminal(f.Fd()) || IsCygwinTerminal(f)
}

View Source

var StartSpinner = func(s *spinner.Spinner) {
	s.Start()
}

We do this so we can stub out the spinner in tests -- it made things really flakey. This is not an elegant solution.

View Source

var StopSpinner = func(s *spinner.Spinner) {
	s.Stop()
}

View Source

var TerminalSize = func(w interface{}) (int, int, error) {
	if f, isFile := w.(*os.File); isFile {
		return terminal.GetSize(int(f.Fd()))
	}

	return 0, 0, fmt.Errorf("%v is not a file", w)
}

Functions ¶

func DisplayURL ¶ added in v0.11.1

func DisplayURL(urlStr string) string

func FuzzyAgo ¶

func FuzzyAgo(ago time.Duration) string

func GreenCheck ¶ added in v0.12.0

func GreenCheck() string

func Humanize ¶ added in v0.6.2

func Humanize(s string) string

func IsCygwinTerminal ¶ added in v0.11.0

func IsCygwinTerminal(f *os.File) bool

func IsURL ¶ added in v0.11.1

func IsURL(s string) bool

func NewColorable ¶

func NewColorable(w io.Writer) io.Writer

NewColorable returns an output stream that handles ANSI color sequences on Windows

func OpenInBrowser ¶

func OpenInBrowser(url string) error

OpenInBrowser opens the url in a web browser based on OS and $BROWSER environment variable

func Pluralize ¶

func Pluralize(num int, thing string) string

func RedX ¶ added in v1.0.0

func RedX() string

func Spinner ¶ added in v0.6.0

func Spinner(w io.Writer) *spinner.Spinner

func YellowDash ¶ added in v1.0.0

func YellowDash() string

Types ¶

type TablePrinter ¶

type TablePrinter interface {
	IsTTY() bool
	AddField(string, func(int, string) string, func(string) string)
	EndRow()
	Render() error
}

func NewTablePrinter ¶

func NewTablePrinter(io *iostreams.IOStreams) TablePrinter

Source Files ¶

View all Source files

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