debug

Documentation

Overview

Package debug provides template functions to help debugging templates.

Index

• type Namespace
  • func New(d *deps.Deps) *Namespace
  • func (ns *Namespace) Dump(val any) string
  • func (ns *Namespace) VisualizeSpaces(val any) string

Types

type Namespace

type Namespace struct {
}

Namespace provides template functions for the "debug" namespace.

func New

func New(d *deps.Deps) *Namespace

New returns a new instance of the debug-namespaced template functions.

func (*Namespace) Dump

func (ns *Namespace) Dump(val any) string

Dump returns a object dump of val as a string. Note that not every value passed to Dump will print so nicely, but we'll improve on that.

We recommend using the "go" Chroma lexer to format the output nicely.

Also note that the output from Dump may change from Hugo version to the next, so don't depend on a specific output.

func (*Namespace) VisualizeSpaces

func (ns *Namespace) VisualizeSpaces(val any) string

VisualizeSpaces returns a string with spaces replaced by a visible string.