util

package

v0.4.0-beta.47 Latest Latest Go to latest Published: Feb 28, 2024 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/elseano/rundown

Documentation ¶

Index ¶

Constants
Variables
func CaptureStdout(f func()) string
func CollapseReturns(input string) string
func Debugf(s string, i ...interface{})
func DecodeCursor(cursor string) (lineDelta, columnDelta int)
func DumpNode(node ast.Node, source []byte) string
func FileExists(name string) bool
func FindFile(files []string) string
func GetConsoleWidth() int
func InspectList(l []string) string
func InspectString(s string) string
func IntMin(a, b int) int
func MakeRelative(filename string) string
func NodeLines(v ast.Node, source []byte) string
func RandomString() string
func ReadAndFormatOutput(reader io.Reader, indent int, prefix string, ...) bool
func RedirectLogger(w io.Writer)
func RemoveColors(input string) string
func SetLoggerLevel(level string)
func SubEnv(environment map[string]string, source string) string
type DummySpinner
- func NewDummySpinner() *DummySpinner
- func (s *DummySpinner) Active() bool
- func (s *DummySpinner) CurrentHeading() string
- func (s *DummySpinner) Error(message string)
- func (s *DummySpinner) HideAndExecute(f func())
- func (s *DummySpinner) NewStep(message string)
- func (s *DummySpinner) SetMessage(message string)
- func (s *DummySpinner) Skip(message string)
- func (s *DummySpinner) Spin()
- func (s *DummySpinner) Start()
- func (s *DummySpinner) Stop()
- func (s *DummySpinner) Success(message string)
type Line
- func (l *Line) MoveCursor(col int)
type ProgressIndicator
type TokenResult
- func NextToken(input string) (token TokenResult, data string, rest string)
type WordWrapWriter
- func NewWordWrapWriter(out io.Writer, columns int) *WordWrapWriter
- func (w *WordWrapWriter) Reset()
- func (w *WordWrapWriter) SetAfterWrap(wrapper func(writer io.Writer) int)
- func (w *WordWrapWriter) Write(b []byte) (n int, err error)

Constants ¶

View Source

const StartOfLine = -999

Variables ¶

View Source

var Logger zerolog.Logger

View Source

var VariableDetection = regexp.MustCompile(`(?i)\$([a-z0-9_]+)|\${([a-z0-9_]+)(([^a-z0-9_]+)(.*?))?}`)

Functions ¶

func CaptureStdout ¶

func CaptureStdout(f func()) string

func CollapseReturns ¶

func CollapseReturns(input string) string

func Debugf ¶

func Debugf(s string, i ...interface{})

func DecodeCursor ¶

func DecodeCursor(cursor string) (lineDelta, columnDelta int)

func DumpNode ¶

func DumpNode(node ast.Node, source []byte) string

func FileExists ¶

func FileExists(name string) bool

func FindFile ¶

func FindFile(files []string) string

Finds a file in the current directory or parents. Files are checked in the order they're provided.

func GetConsoleWidth ¶

func GetConsoleWidth() int

func InspectList ¶

func InspectList(l []string) string

func InspectString ¶

func InspectString(s string) string

func IntMin ¶

func IntMin(a, b int) int

func MakeRelative ¶

func MakeRelative(filename string) string

func NodeLines ¶

func NodeLines(v ast.Node, source []byte) string

func RandomString ¶

func RandomString() string

func ReadAndFormatOutput ¶

func ReadAndFormatOutput(reader io.Reader, indent int, prefix string, progressIndicator ProgressIndicator, out *bufio.Writer, logger *log.Logger, initialHeading string) bool

func RedirectLogger ¶

func RedirectLogger(w io.Writer)

func RemoveColors ¶

func RemoveColors(input string) string

func SetLoggerLevel ¶

func SetLoggerLevel(level string)

func SubEnv ¶

func SubEnv(environment map[string]string, source string) string

Performs environment substitution on the source string. Supports $VAR, or ${VAR} optionally with the -, :-, +, :+ modifiers. Ignores other (or invalid) modifiers, substituting as if they weren't there.

Types ¶

type DummySpinner ¶

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

func NewDummySpinner ¶

func NewDummySpinner() *DummySpinner

func (*DummySpinner) Active ¶

func (s *DummySpinner) Active() bool

func (*DummySpinner) CurrentHeading ¶

func (s *DummySpinner) CurrentHeading() string

func (*DummySpinner) Error ¶

func (s *DummySpinner) Error(message string)

func (*DummySpinner) HideAndExecute ¶

func (s *DummySpinner) HideAndExecute(f func())

func (*DummySpinner) NewStep ¶

func (s *DummySpinner) NewStep(message string)

func (*DummySpinner) SetMessage ¶

func (s *DummySpinner) SetMessage(message string)

func (*DummySpinner) Skip ¶

func (s *DummySpinner) Skip(message string)

func (*DummySpinner) Spin ¶

func (s *DummySpinner) Spin()

func (*DummySpinner) Start ¶

func (s *DummySpinner) Start()

func (*DummySpinner) Stop ¶

func (s *DummySpinner) Stop()

func (*DummySpinner) Success ¶

func (s *DummySpinner) Success(message string)

type Line ¶

type Line struct {
	LastColumn        int
	FormattingStash   string
	CurrentlyIndented bool
	Dirty             bool
}

func (*Line) MoveCursor ¶

func (l *Line) MoveCursor(col int)

type ProgressIndicator ¶

type ProgressIndicator interface {
	Start()
	Stop()
	Active() bool
	CurrentHeading() string
}

type TokenResult ¶

type TokenResult int

const (
	TokenCursor TokenResult = iota + 1
	TokenColour
	TokenWhitespace
	TokenDisplayStream
	TokenEmpty
)

func NextToken ¶

func NextToken(input string) (token TokenResult, data string, rest string)

type WordWrapWriter ¶

type WordWrapWriter struct {
	io.Writer
	AfterWrap      func(writer io.Writer) int
	CurrentLinePos int
	Columns        int
	// contains filtered or unexported fields
}

func NewWordWrapWriter ¶

func NewWordWrapWriter(out io.Writer, columns int) *WordWrapWriter

func (*WordWrapWriter) Reset ¶

func (w *WordWrapWriter) Reset()

func (*WordWrapWriter) SetAfterWrap ¶

func (w *WordWrapWriter) SetAfterWrap(wrapper func(writer io.Writer) int)

func (*WordWrapWriter) Write ¶

func (w *WordWrapWriter) Write(b []byte) (n int, err error)

Source Files ¶

View all Source files

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