This repository has been archived on 2022-08-17. You can view files and clone it, but cannot push or open issues or pull requests.
dex/vendor/github.com/kylelemons/godebug/README.md
2016-08-05 09:54:03 -07:00

2 KiB

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 go-spew.