0.3.1

This is a minor release with several improvements, especially the debug mode to actively detect invalid ranges. OCaml 5.2.0 introduced backward-incompatible changes in ocaml/ocaml#12477 and thus we had to bump up the minimum OCaml version.

Bug Fixes

• correct and enhance the debug mode (#142) (db89139)
• Diagnostic: use Format.pp_infinity in string_of_text for OCaml 5.2 (#149) (b835fac)
• dim the carets (#145) (08c7dc2)

Features

• comprehensive checking for ranges (#147) (891d627)
• Explicator: introduce debug mode (#139) (9830591)
• Range: re-introduce split (7cdce93)

0.3.0

This is a major release with two notable changes:

1. New special EOF ranges were introduced to highlight the end of a file. The terminal renderer will show “‹EOF›” and highlight it if a special EOF range is used.
2. The terminal renderer was rewritten (again). Its visual appearance is almost identical to the previous one, except that the “faint” style replaces the gray coloring. Internally, it no longer uses notty (thus reducing the dependencies to a minimum), and it now automatically detects the environment variable NO_COLOR, following the specification at https://no-color.org/.

BREAKING CHANGES

• Range: because of the new special EOF ranges, split is deprecated and will be removed soon; use view instead

Bug Fixes

• Reporter: backtrace frames no longer inherit locations (#128) (bbd7d0b)
• Tty: drop notty and use the "faint" style (#135) (1988a5a)
• upgrade the dependency algaeff to 2.0.0 (#132) (6e8b9a2)

Features

• MinimumSigs: new signatures to help library authors hide internal reporters (#126) (058171c)
• Range: allow special EOF ranges (#125) (1b85fbd)
• Tty: detect NO_COLOR (472f096)

0.2.0

This is a major release with many backward incompatible changes.

The most significant change is the introduction of StructuredReporter. The library can thus be used in two different modes:

1. Use Reporter (as the old Logger): its API is biased towards free-form explanations.
2. Use StructuredReporter: its API is biased towards fully structured messages.

Both modes share the same type of diagnostics, and thus, an application using structured messages can adopt a library using free-form explanations and vice versa. Great care has been taken to make sure the two modes can work together. The current tutorial focuses on Reporter and free-form explanations because we think that mode is slightly easier to set up.

The second most significant change is that the TTY handler got an overhaul. The output is now more concise, informational, and beautiful.

Thanks to @mikeshulman for many valuable suggestions.

BREAKING CHANGES

• Span is renamed to Range
• Logger is renamed to Reporter and Reporter.Code is renamed to Reporter.Message
• Range: the type position was changed to allow string (in-memory) sources
• Diagnostic: the type diagnostic was changed and message was renamed to loctext
• The LSP handler is separated out as a new package (not published yet)

Bug Fixes

• Diagnostic: fix and improve string_of_text
  • (#83) (e32adc5)
  • (b00d8cd)

Features

• introduce StructuredReporter for fully structured messages
  • (#97) (add65f8)
• Range: allow string (in-memory) sources
  • (#90) (ae62741)
  • (#101) (4b6819a)
  • (a944e66)
• Tty: completely redesign the TTY output
  • (#81) (9685bc9)
  • (#91) (07fe241)
  • (#93) (c3f0747)
  • (39e7154)
  • (a9caca1)
  • (#114) (5d2066b)

0.1.1

Bug Fixes

• OPAM: remove the unused dependencies that caused trouble (101b10f)
• OPAM: we actually need lsp 1.15 (f715e7f)

0.1.0

The first official release!