Errata is an extremely customizable error pretty printer that can handle many kinds of error formatting.
Errata can handle errors that are all over the source or errors that are connected to each other spanning multiple lines. You can be as simple or as fancy as you like!
You can also customize the format of the printer in several ways:
- Custom messages and labels
- Custom character sets for symbols
- Highlighting the source, messages, and symbols
A clean, modern error message that is trying to be helpful:
A busy error message with underlining and connections:
Errata uses PVP Versioning.
- Updated for GHC 9.4 and 9.6.
Added styling individual pointers with
PointerStyle(e.g. characters, highlighting).
This changes how
highlightworks and moves
This also adds a
PointerStyleparameter to the helper functions so e.g.
blockSimple fancyStyle ...should now be
blockSimple fancyStyle fancyPointer ....
Crazy example from the tests (you can imagine coloring things differently):
an error --> here:1:1 | 1 | abcdefghijk | .. ~~ ^^ z | | : | | 2 y | 1 x 2 | lmnopqrstuv | ''' w an error occurred here
Moved existing and added new premade styles to
Erratano longer exports premade styles. Also moved
Added support for characters with different widths (full-width, combining characters, others). The cabal flag
usewcwidth(default false) can be enabled to use the native
Added support for replacing tabs with spaces with the
Style(defaults to 4).
Added option for the lines before and after the omission line with
Added option for padding lines before and after the source
Added option for disabling the hook with
Added option for toggling all decorations completely with
Style. Useful if you only want highlighting and not underlining. Combine with
stylePaddingTop = Falsefor a compact source code block.
Added option for toggling the line prefixes with
Showinstances to all the types. Style functions are applied to some sample text.
Sourceto just requiring an
Fixed trailing whitespace in the omission line.
Support GHC 9.0.1 (and eventually 9.2).
Reworked the pretty printer so that it no longer prints trailing whitespace in most places.
errataBlockfield, and only use
errataBlocks. Now, an
Erratacan have no blocks attached to it at all. They will also no longer be sorted beforehand, as that should be up to the user.
prettyErrorsNE, as it is no longer useful for what it was documented for.
Fixed the rendering of
Blocks with no
Pointers adding extra blank lines.
Block, which will put text underneath the location text but above the source lines. This also affects all the block helper functions, which now have an argument for the header.
blockSimple'functions are now passed tuples of positions and labels instead of
Ints, which is more consistent with the rest of the helper functions.
Defined type synonyms for line, column, headers, bodies, and labels, for the purpose of documentation. It should be much easier to know what is expected by just reading the types now.
GHC.Arr.Arrayfor keeping source lines, which should be faster for indexing and should not force the individual lines until they are needed.
- Initial release.