text

package

v0.0.0-...-a5c7b19 Latest Latest Go to latest Published: Jan 16, 2026 License: MIT Imports: 10 Imported by: 0

Details

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

Repository

github.com/tim-hardcastle/pipefish

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Capitalize(s string) string
func Cyan(s string) string
func DescribeOpposite(tok *token.Token) string
func DescribePos(token *token.Token) string
func DescribeTok(tok *token.Token) string
func Emph(s string) string
func EmphType(s string) string
func ErrorFont(s string) string
func ExtractFileName(s string) string
func Flatten(s string) string
func FlattenedFilename(s string) string
func GetTextWithBarsAsList(text string) ([]string, bool)
func Green(s string) string
func Head(s, substr string) bool
func HighlightLine(plainLine string, highlighter rune) (string, rune)
func MakeFilepath(scriptFilepath string) string
func Pretty(s string, lMargin, rMargin int) string
func ReadChar() rune
func Red(s string) string
func StripColors(s string) string
func Tail(s, substr string) bool
func ToEscapedText(s string) string
func Trim(path string) string
func TweakNameAndPath(name, path, source string) (string, string)
func WithoutDots(s string) string
func Yellow(s string) string
type Markdown
- func NewMarkdown(leftMargin string, rightMargin int, highlight func(string) string) *Markdown
- func (md *Markdown) Render(text []string) string
- func (md *Markdown) RenderLeftPad(pad string, text []string) string

Constants ¶

View Source

const (
	RESET                  = "\033[0m"
	RESET_FOREGROUND       = "\033[39m"
	RESET_BACKGROUND       = "\033[49m"
	RESET_BOLD             = "\033[22m"
	RESET_ITALIC           = "\033[23m"
	RESET_UNDERLINE        = "\033[24m"
	UNDERLINE              = "\033[4m"
	RED                    = "\033[31m"
	BAD_RED                = "\033[38;2;244;71;71m"
	YELLOW                 = "\033[33m"
	GREEN                  = "\033[32m"
	BLUE                   = "\033[34m"
	PURPLE                 = "\033[35m"
	CYAN                   = "\033[36m"
	GRAY                   = "\033[37m"
	INLINE_CODE_BACKGROUND = "\033[48;2;0;0;64m"
	WHITE                  = "\033[97m"
	ITALIC                 = "\033[3m"
	BOLD                   = "\033[1m"
	BULLET                 = "  ▪ "
	MASK                   = '▪'
	RT_ERROR               = "<R>Error</>: "
	ERROR                  = "<R>Error</>: "
	ORANGE                 = "\033[38;2;255;165;0m"
)

Variables ¶

This section is empty.

Functions ¶

func Capitalize ¶

func Capitalize(s string) string

What it says.

func Cyan ¶

func Cyan(s string) string

func DescribeOpposite ¶

func DescribeOpposite(tok *token.Token) string

func DescribePos ¶

func DescribePos(token *token.Token) string

func DescribeTok ¶

func DescribeTok(tok *token.Token) string

Describes a token for the purposes of error messages etc.

func Emph ¶

func Emph(s string) string

func EmphType ¶

func EmphType(s string) string

func ErrorFont ¶

func ErrorFont(s string) string

func ExtractFileName ¶

func ExtractFileName(s string) string

func Flatten ¶

func Flatten(s string) string

func FlattenedFilename ¶

func FlattenedFilename(s string) string

func GetTextWithBarsAsList ¶

func GetTextWithBarsAsList(text string) ([]string, bool)

func Green ¶

func Green(s string) string

func Head ¶

func Head(s, substr string) bool

func HighlightLine ¶

func HighlightLine(plainLine string, highlighter rune) (string, rune)

func MakeFilepath ¶

func MakeFilepath(scriptFilepath string) string

func Pretty ¶

func Pretty(s string, lMargin, rMargin int) string

func ReadChar ¶

func ReadChar() rune

func Red ¶

func Red(s string) string

func StripColors ¶

func StripColors(s string) string

func Tail ¶

func Tail(s, substr string) bool

func ToEscapedText ¶

func ToEscapedText(s string) string

func Trim ¶

func Trim(path string) string

Removes the last two folders in a filepath. TODO --- don't.

func TweakNameAndPath ¶

func TweakNameAndPath(name, path, source string) (string, string)

func WithoutDots ¶

func WithoutDots(s string) string

func Yellow ¶

func Yellow(s string) string

Types ¶

type Markdown ¶

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

func NewMarkdown ¶

func NewMarkdown(leftMargin string, rightMargin int, highlight func(string) string) *Markdown

func (*Markdown) Render ¶

func (md *Markdown) Render(text []string) string

func (*Markdown) RenderLeftPad ¶

func (md *Markdown) RenderLeftPad(pad string, text []string) string

Source Files ¶

View all Source files

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