lscolors

Documentation

Overview

Package lscolors provides methods for colorizing file names based on colors from dircolors

Index

• Constants
• Variables
• func Colorize(file string) string
• func ColorizePath(fullPath string) string
• func GetColor(file string) string

Examples

• Colorize
• ColorizePath
• GetColor

Constants

const (
	RESET  = "rs" // Reset
	DIR    = "di" // Directory
	LINK   = "ln" // Symbolic link
	FIFO   = "pi" // Pipe
	SOCK   = "so" // Socket
	BLK    = "bd" // Block device driver
	CHR    = "cd" // Character device driver
	STICKY = "st" // Dir with the sticky bit set (+t) and not other-writable
	EXEC   = "ex" // Executable files
)

Variables

var DisableColors = os.Getenv("NO_COLOR") != ""

DisableColors disables all colors in output

Functions

func Colorize

func Colorize(file string) string

Colorize return file name with ANSI control sequences

Example

file := "myfile.txt"
fmt.Println(Colorize(file))

func ColorizePath

func ColorizePath(fullPath string) string

Colorize return path with ANSI control sequences

Example

path := "/home/john/myfile.txt"
fmt.Println(ColorizePath(path))

func GetColor

func GetColor(file string) string

GetColor returns ANSI control sequence with color for given file

Example

file := "myfile.txt"
dir := "/home/john"

colorSeq := GetColor(file)

fmt.Printf(
	"%s/"+colorSeq+"%s"+GetColor(RESET)+"\n",
	dir, file,
)