formatters

Documentation

Index

• Variables
• func Get(name string) chroma.Formatter
• func Names() []string
• func Register(name string, formatter chroma.Formatter) chroma.Formatter

Variables

var Fallback = NoOp

Fallback formatter.

var JSON = Register("json", chroma.FormatterFunc(func(w io.Writer, s *chroma.Style, it chroma.Iterator) error {
	fmt.Fprintln(w, "[")
	i := 0
	for t := it(); t != nil; t = it() {
		if i > 0 {
			fmt.Fprintln(w, ",")
		}
		i++
		bytes, err := json.Marshal(t)
		if err != nil {
			return err
		}
		if _, err := fmt.Fprint(w, "  "+string(bytes)); err != nil {
			return err
		}
	}
	fmt.Fprintln(w)
	fmt.Fprintln(w, "]")
	return nil
}))

JSON formatter outputs the raw token structures as JSON.

var (
	// NoOp formatter.
	NoOp = Register("noop", chroma.FormatterFunc(func(w io.Writer, s *chroma.Style, iterator chroma.Iterator) error {
		for t := iterator(); t != nil; t = iterator() {
			if _, err := io.WriteString(w, t.Value); err != nil {
				return err
			}
		}
		return nil
	}))
)

var Registry = map[string]chroma.Formatter{}

Registry of Formatters.

var TTY16m = Register("terminal16m", chroma.FormatterFunc(trueColourFormatter))

TTY16m is a true-colour terminal formatter.

var TTY256 = Register("terminal256", &indexedTTYFormatter{ttyTables[256]})

TTY256 is a 256-colour terminal formatter.

The Lab colour space is used to map RGB values to the most appropriate index colour.

var TTY8 = Register("terminal", &indexedTTYFormatter{ttyTables[8]})

TTY8 is an 8-colour terminal formatter.

The Lab colour space is used to map RGB values to the most appropriate index colour.

var Tokens = Register("tokens", chroma.FormatterFunc(func(w io.Writer, s *chroma.Style, it chroma.Iterator) error {
	for t := it(); t != nil; t = it() {
		if _, err := fmt.Fprintln(w, t.GoString()); err != nil {
			return err
		}
	}
	return nil
}))

Tokens formatter outputs the raw token structures.

Functions

func Get

func Get(name string) chroma.Formatter

Get formatter by name.

If the given formatter is not found, the Fallback formatter will be returned.

func Names

func Names() []string

Names of registered formatters.

func Register

func Register(name string, formatter chroma.Formatter) chroma.Formatter

Register a named formatter.