Feature: Diagnostic Report Handler TUI

sambacha commented 2 years ago

Component

Forge, Cast, Anvil

Describe the feature you would like

Diagnostic Report Handler for Foundry's TUI

Integrate a new terminal/shell interface crate to improve readability and UI/UX

Basically, integrate miette as the presentation interface for displaying error outputs / diagnostic messages from forge tests (and possibly enrich compiler messages to fit the format?)

The miette crate also comes bundled with a default ReportHandler

Fancy graphical diagnostic output, using ANSI/Unicode text
single- and multi-line highlighting support
Screen reader/braille support, gated on NO_COLOR, and other heuristics.
Fully customizable graphical theming (or overriding the printers entirely).
Cause chain printing
Turns diagnostic codes into links in [supported terminals]

Example Error Handling Display

A great example would be providing a diagnostic code URL for the corresponding 4 byte signature of a function. This would basically build on this suggested proposed feature: https://github.com/foundry-rs/foundry/issues/1672

Mockup

Not Foundry I know

Diagnostic Code URL

Informative Resources

Hyperlinks (a.k.a. HTML-like anchors) in terminal emulators

miette GitHub repo

miette at docs.rs

Additional context

No response

sambacha commented 2 years ago

This could also be useful for this issue as well: https://github.com/foundry-rs/foundry/issues/1795

sambacha commented 1 year ago

This TUI should actually instead use highlighting as opposed to strictly using symbols for pointing so that it can be independent of terminals screen size

zerosnacks commented 2 months ago

foundry-rs / foundry