miette/CHANGELOG.md

0.11.0 (2021-08-18)

BIG changes this time. The whole end-to-end experience for tossing around Diagnostics in your code has been overhauled, printing reports is easier than ever, and we even have an eyre::Report-style wrapper you can pass around in app-internal returns!

Features

• reporter: Overhauled return type/main/DiagnosticReport experience. (29c1403e)

0.10.0 (2021-08-17)

Lots of goodies in this release! I'm working hard on the 1.0.0 Roadmap, so things are changing pretty quick, and I thought it would be nice to release this checkpoint.

Bug Fixes

• protocol: keep the owned spans (49151bb0)

Features/Breaking Changes

• derive: Allow anything Clone + Into to be used as a Span (385171eb)
• offsets:
  • nice utility function to get an offset from a Rust callsite (26f409c5)
  • utility function for converting from line/col to offset (75c23127)
  • more utility From impls for SourceSpan (95200366)
• protocol:
  • add Source impls for Cow and Arc (53074d34)
  • reference-based DiagnosticReport! (f390520b)

0.9.0 (2021-08-17)

Yay new version already! A pretty significant API change, too! <20><>

Breaking Changes

SourceSpans have changed a bit: for one, they're based on offset/length now, instead of start/end. For two, they have a new Option<String> field, label, which is meant to be used by reporters in different contexts. For example, highlight snippets will use them as the labels for underlined sections of code, while the snippet context will use the label as the "file name" for the Source they point to.

• protocol: new SourceSpans with labels (acfeb9c5)

Bug Fixes

• derive: allow unused variables for the snippets method (f704d6a9)

Features

• protocol: implement From<(usize, usize)> for SourceSpan (36b86df9)

0.8.1 (2021-08-17)

Just a small bump to update the readme (and docs.rs in the process) with the new snippet derive stuff. No notable changes.

0.8.0 (2021-08-17)

You can full-on use #[derive(Diagnostic)] to define snippets now. That's a big deal.

Features

• derive: Support for deriving snippet method (#18) (f6e6acf2)

0.7.0 (2021-08-16)

Welp. 0.6.0 was basically completely broken, so I tore out the darling-based derive macros and rewrote the whole thing using syn, and things are much better now!

There's still a few bits and bobs to add, like snippets (oof. big.), and full help format string support (they don't quite work in enums right now), but otherwise, this is pretty usable~

Features

• derive: improved derive support, including partial help format string support! (9ef0dd26)

Bug Fixes

• derive: move to plain syn to fix darling issues (9a78a943)

0.6.0 (2021-08-15)

We haz a basic derive macro now!

Features

• derive: added basic derive macro (0e770270)

0.5.0 (2021-08-14)

I decided to yank some handy (optional) utilities from a project I'm using miette in. These should make using it more ergonomic.

Features

• utils: various convenience utilities for creating and working with Diagnostics (a9601368)

0.4.0 (2021-08-11)

Time for another (still experimental!) change to Diagnostic. It will probably continue to change as miette gets experimented with, until 1.0.0 stabilizes it. But for now, expect semi-regular breaking changes of this kind.

Oh and I tracked down a rogue \n that was messing with the default reporter and managed to get out of it with at least some of my sanity.

Breaking Changes

• protocol: Simplify protocol return values further (02dd1f84, breaks #)

Bug Fixes

• reporter:
  • fix reporter and tests... again (d201dde4)
  • fix extra newline after header (0d2e3312)

0.3.1 (2021-08-11)

This is a tiny release to fix a reporter rendering bug.

Bug Fixes

• reporter: fix missing newline before help text (9d430b6f)

0.3.0 (2021-08-08)

This version is the result of a lot of experimentation with getting the Diagnostic API right, particularly Diagnostic::snippets(), which is something that should be writable in several different ways. As such, it includes some breaking changes, but they shouldn't be too hard to figure out.

Breaking Changes

• protocol:
  • improvements to snippets API (3584dc60)
  • help is a single Display ref now. (80e7dabb)

Bug Fixes

• tests: updating tests (60bdf47e)

0.2.1 (2021-08-05)

I think this is the right thing to do re: From!

Bug Fixes

• protocol: fix the default From<:T Diagnostic> implementation to cover more cases. (781a51f0)

0.2.0 (2021-08-05)

Starting to get some good feedback on the protocol and APIs, so some improvements were made.

Breaking changes

You might need to add + Send + Sync + 'static to your Box<dyn Diagnostic> usages now, since Diagnostic no longer constrains on any of them.

Additionally, Diagnostic::help(), Diagnostic::code(), and SpanContents have had signature changes that you'll need to adapt to.

• protocol: protocol improvements after getting feedback (e955321c)
• protocol: Make use of ? and return types with Diagnostics more ergonomic (50238d75)

0.1.0 (2021-08-05)

I'm really excited to put out this first release of miette! This version defines the current protocol and includes a basic snippet reporter. It's fully documented and ready to be used!

Disclaimer: This library is still under pretty heavy development, and you should only use this if you're interested in using something experimental. Any and all design comments and ideas are welcome over on GitHub

Bug Fixes

• api: stop re-exporting random things wtf??? (2fb9f93c)
• protocol: use references for all return values in Diagnostic (c3f41b97)

Features

• protocol: sketched out a basic protocol (e2387ce2)
• reporter: dummy reporter implementation + tests (a437f445)
• span: make span end optional (1cb0ad38)

0.0.0 (2021-08-03)

Don't mind me, just parking this crate name.