godebug

module
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 8, 2023 License: Apache-2.0

README

Pretty Printing for Go

godebug build status

Have you ever wanted to get a pretty-printed version of a Go data structure, complete with indentation? I have found this especially useful in unit tests and in debugging my code, and thus godebug was born!

Quick Examples

By default, pretty will write out a very compact representation of a data structure. From the Print example:

{Name:     "Spaceship Heart of Gold",
 Crew:     {Arthur Dent:       "Along for the Ride",
            Ford Prefect:      "A Hoopy Frood",
            Trillian:          "Human",
            Zaphod Beeblebrox: "Galactic President"},
 Androids: 1,
 Stolen:   true}

It can also produce a much more verbose, one-item-per-line representation suitable for computing diffs. See the documentation for more examples and customization.

Documentation

Documentation for this package is available at godoc.org:

  • Pretty: godoc for godebug/pretty
  • Diff: godoc for godebug/diff

Installation

These packages are available via go get:

$ go get -u github.com/kylelemons/godebug/{pretty,diff}

Other Packages

If godebug/pretty is not granular enough, I highly recommend checking out cmp or go-spew.

Directories

Path Synopsis
Package diff implements a linewise diff algorithm.
Package diff implements a linewise diff algorithm.
Package pretty pretty-prints Go structures.
Package pretty pretty-prints Go structures.

Jump to

Keyboard shortcuts

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