#error-message #diagnostics #syn #miette #pretty

syn-miette

A syn::Error wrapper that provides pretty diagnostic messages using miette

3 releases (breaking)

0.3.0 Apr 8, 2024
0.2.0 Mar 17, 2024
0.1.0 Oct 4, 2023

#6 in #miette


Used in 3 crates

MIT/Apache

15KB
245 lines

A syn::Error wrapper that provides pretty diagnostic messages using miette.

Usage

let source = r"
pub struct {
    num_yaks: usize
}";

let error = syn::parse_str::<syn::DeriveInput>(source).unwrap_err();
let error = syn_miette::Error::new(error, source);

assert_eq!(
    error.render(), // only with `--feature render`
"  × expected identifier
   ╭─[2:12]
 1 │
 2 │ pub struct {
   ·            ┬
   ·            ╰── expected identifier
 3 │     num_yaks: usize
   ╰────
"
);

Notably, Error properly renders children that have been syn::Error::combine-ed:

  × duplicate definition of `Foo`
   ╭─[1:8]
 1 │ struct Foo;
   ·        ─┬─
   ·         ╰── initial definition here
 2 │ enum Bar {}
 3 │ union Foo {}
   ·       ─┬─
   ·        ╰── duplicate definition of `Foo`
   ╰────

Dependencies

~1.6–7MB
~51K SLoC