groom

Pretty printing for well-behaved Show instances.

LTS Haskell 22.42:0.1.2.1
Stackage Nightly 2024-11-24:0.1.2.1
Latest on Hackage:0.1.2.1

See all snapshots groom appears in

BSD-3-Clause licensed by Edward Z. Yang
Maintained by [email protected]
This version can be pinned in stack with:groom-0.1.2.1@sha256:b3be67cea27ec403032d23649f9995048fecb39f885d6b62b42209ada0fda636,1771

Module documentation for 0.1.2.1

Used by 3 packages in lts-22.38(full list with versions):
amazonka-test, data-msgpack, groom

Automatically derived Show instances are an easy way to inspect data in your program. However, for large data-structures, the resulting output lacks whitespace, making it unreadable. Groom offers an replacement to show called groom which attempts to pretty-print the output of show. For example:

let x = parseExp "foobar 1 [1,2]"
in do
  putStrLn (show x)
  putStrLn (groom x)

results in:

ParseOk (App (App (Var (UnQual (Ident "foobar"))) (Lit (Int 1))) (List [Lit (Int 1),Lit (Int 2)]))
ParseOk
  (App (App (Var (UnQual (Ident "foobar"))) (Lit (Int 1)))
     (List [Lit (Int 1), Lit (Int 2)]))

Groom works only on Show instances that output valid Haskell code; if Groom can't understand its input, it will not make any changes.