color

README

Color

Color is a library for colouring things.

Usage

package main

import (
    "fmt"
    "runtime"

    "github.com/jpedro/color"
)

func main() {
    name := "green"
    text := "Runtime OS: %s"
    fmt.Println(color.Paint(name, text, runtime.GOOS))
}

Check the cli/color for your terminal needs.

Todos

• Create fallback color
• Add color groups. Now via color.Parse()
• Add custom color painters. Now via color.NewColor()
• Name all the 256 term colors

Documentation

Overview

Color is a library for colouring things.

Installation

Install the cli with:

go get github.com/jpedro/color/cli/color

Usage

Sample code:

package main

import (
    "fmt"

    "github.com/jpedro/color"
)

func main() {
    fmt.Println(color.Green("Hello %s!", "lush green"))
}

Index

• func Blue(text interface{}, args ...interface{}) string
• func Cyan(text interface{}, args ...interface{}) string
• func Gray(text interface{}, args ...interface{}) string
• func Green(text interface{}, args ...interface{}) string
• func Magenta(text interface{}, args ...interface{}) string
• func Paint(color string, text interface{}, args ...interface{}) string
• func Pale(text interface{}, args ...interface{}) string
• func Parse(text string, args ...interface{}) string
• func Red(text interface{}, args ...interface{}) string
• func Yellow(text interface{}, args ...interface{}) string
• type Color
  • func NewColor() *Color
  • func (c *Color) Background(text string) *Color
  • func (c *Color) Bold() *Color
  • func (c *Color) Foreground(text string) *Color
  • func (c *Color) Paint(text interface{}, args ...interface{}) string
  • func (c *Color) Underline() *Color

Functions

func Blue

func Blue(text interface{}, args ...interface{}) string

Shortcut for color.Paint("blue", text)

func Cyan

func Cyan(text interface{}, args ...interface{}) string

Shortcut for color.Paint("cyan", text)

func Gray

func Gray(text interface{}, args ...interface{}) string

Shortcut for color.Paint("gray", text)

func Green

func Green(text interface{}, args ...interface{}) string

Shortcut for color.Paint("green", text)

func Magenta

func Magenta(text interface{}, args ...interface{}) string

Shortcut for color.Paint("magenta", text)

func Paint

func Paint(color string, text interface{}, args ...interface{}) string

Returns shell coloured output for text and args

func Pale

func Pale(text interface{}, args ...interface{}) string

Shortcut for color.Paint("pale", text)

func Parse

func Parse(text string, args ...interface{}) string

Returns a painted string with groups like `{green|this should be green}` replaced with `this should be green` in green color

func Red

func Red(text interface{}, args ...interface{}) string

Shortcut for color.Paint("red", text)

func Yellow

func Yellow(text interface{}, args ...interface{}) string

Shortcut for color.Paint("yellow", text)

Types

type Color

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

func NewColor

func NewColor() *Color

func (*Color) Background

func (c *Color) Background(text string) *Color

Select a color for your background

func (*Color) Bold

func (c *Color) Bold() *Color

Turns the text bold

func (*Color) Foreground

func (c *Color) Foreground(text string) *Color

Select a color for your foreground

func (*Color) Paint

func (c *Color) Paint(text interface{}, args ...interface{}) string

Paints text and args according to its settings

func (*Color) Underline

func (c *Color) Underline() *Color

Turns the text underlined