5 releases

0.1.3 Jul 29, 2021
0.1.2 Jul 16, 2021
0.1.1 Jul 16, 2021
0.1.0 Jul 15, 2021
0.0.0 Jul 15, 2021

#87 in Visualization

Download history 78/week @ 2021-07-11 81/week @ 2021-07-18 95/week @ 2021-07-25 84/week @ 2021-08-01 74/week @ 2021-08-08 76/week @ 2021-08-15 81/week @ 2021-08-22 55/week @ 2021-08-29 55/week @ 2021-09-05 69/week @ 2021-09-12 53/week @ 2021-09-19

75 downloads per month
Used in 4 crates (3 directly)

MIT license

57KB
1K SLoC

Ariadne

crates.io crates.io License actions-badge

A fancy compiler diagnostics crate.

Example

Ariadne supports arbitrary multi-line spans

See examples/ for more examples.

About

ariadne is a sister project of chumsky. Neither are dependent on one-another, but I'm working on both simultaneously and like to think that their features compliment each other. If you're thinking of using ariadne to process your compiler's output, why not try using chumsky to process its input?

Features

  • Inline and multi-line labels capable of handling arbitrary configurations of spans
  • Multi-file errors
  • Generic across custom spans and file caches
  • A choice of character sets to ensure compatibility
  • Coloured labels & highlighting with 8-bit and 24-bit color support (thanks to yansi)
  • Label priority and ordering
  • Compact mode for smaller diagnostics
  • Correct handling of variable-width characters such as tabs
  • A ColorGenerator type that generates distinct colours for visual elements.
  • A plethora of other options (tab width, label attach points, underlines, etc.)
  • Built-in ordering/overlap heuristics that come up with the best way to avoid overlapping & label crossover

Planned Features

  • Improved layout planning & space usage
  • Non-ANSI terminal support
  • More accessibility options (screenreader-friendly mode, textured highlighting as an alternative to color, etc.)
  • More color options
  • Better support for layout restrictions (maximum terminal width, for example)

Stability

The API (should) follow semver. However, this does not apply to the layout of final error messages. Minor tweaks to the internal layout heuristics can often result in the exact format of error messages changing with labels moving slightly. If you experience a change in layout that you believe to be a regression (either the change is incorrect, or makes your diagnostics harder to read) then please open an issue.

Credit

Thanks to:

  • @brendanzab for their beautiful codespan crate that inspired me to try pushing the envelope of error diagnostics.

  • @estebank for showing innumerable people just how good compiler diagnostics can be through their work on Rust.

Dependencies

~54KB