A new formatting library
|Version on this page:||0.5.0.0@rev:1|
|LTS Haskell 20.23:||0.6.3.0|
|Stackage Nightly 2023-05-30:||0.6.3.0|
|Latest on Hackage:||0.6.3.0|
Module documentation for 0.5.0.0
A new formatting library that tries to be simple to understand while still being powerful and providing more convenience features than other libraries (like functions for pretty-printing maps and lists, or a function for printing arbitrary datatypes using generics).
A comparison with other libraries:
Text.Printf) takes a formatting string and uses some type tricks to accept the rest of the arguments polyvariadically. It's very concise, but there are some drawbacks – it can't produce
Text(you'd have to
T.packit every time) and it doesn't warn you at compile-time if you pass wrong arguments or not enough of them.
text-format takes a formatting string with angle brackets denoting places where arguments would be substituted (the arguments themselves are provided via a tuple). If you want to apply formatting to some of the arguments, you have to use one of the provided formatters. Like
printf, it can fail at runtime, but at least the formatters are first-class (and you can add new ones).
formatting takes a formatting template consisting of pieces of strings interleaved with formatters; this ensures that arguments always match their placeholders.
formattingprovides lots of formatters and generally seems to be the most popular formatting library here. Unfortunately, at least in my experience writing new formatters can be awkward and people sometimes have troubles understanding how
fmt (i.e. this library) provides formatters that are ordinary functions, and a bunch of operators for concatenating formatted strings; those operators also do automatic conversion. There are some convenience formatters which aren't present in
formatting(like ones for formatting maps, lists, converting to base64, etc). Some find the operator syntax annoying, while others like it.
From this version on,
blockListFnever puts blank lines between items. If you want blank lines between items, I’m afraid that you’ll have to add them manually (by e.g. adding a blank line to each item).
blockListF'can be used to create lists with custom bullets.
|+because HLint can’t handle
#|and everyone uses HLint apparently.
- Added time formatters (see
formatLnto be polyvariadic.
genericFfor formatting arbitrary data.
|#because they turn out to be easier to type.
Added a migration guide from
Changed output of
text-format, because in some cases it’s nicer than brackets.
indent'to always add newlines.
Added some formatters:
- formatters for lists, maps and tuples (
baseFand floating-point formatters
hexFwhich works on both numbers and bytestrings
- padding and trimming formatters
- conditionals (
Fmtbecause orphan instances are controversial.
Exported internal classes and functions from
Made all operators associate to the right (
Builderdocumentation says it’s faster than the opposite).
>%%<so that it’d be possible to write
%<a>%%<b>%instead of weird
%<< ... >>%, which work work
Buildable. If you don’t care about speed and just want to output something, use them.
IO ()instance in
Fmt.IO. If you import that module, raw formatted strings would print themselves.
Changed fixities of operators so that
Changed license to BSD3 since all our dependencies are BSD3 and we can’t use MIT.
First (completely experimental) release.