Skip to content

Commit 40a6a01

Browse files
committed
docs: Update changelog
1 parent 334eaa9 commit 40a6a01

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

CHANGELOG.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,44 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77
<!-- next-header -->
88
## [Unreleased] - ReleaseDate
99

10+
### Migration
11+
12+
Note that the top-level type changed from `Message` to `Report`.
13+
`Message` is now a single block of text within a `Report`.
14+
15+
- Replace `Message::footer` with either
16+
- adding a `Message` to a `Group`
17+
- starting a new `Group`
18+
- Replace `Level::<Variant>` with `Level::<VARIANT>`, e.g. `Level::Error` -> `Level::ERROR`
19+
- Instead of creating `Snippet`s on a `Message` (the type returned by `Level::title`), add them to the `Group` that is created with the `Title`
20+
- `Snippet::origin` has been renamed to `Snippet::path`
21+
- Instead of creating an `Annotation` from a `Level`, create them from an `AnnotationKind`
22+
- `AnnotationKind::Primary` will automatically match the `Level` of the `Group`
23+
- All others existing annotations should likely be `AnnotationKind::Context`
24+
- `Level::title` has been replaced with `Level::primary_level` (for first `Group`) and `Level::secondary_level` (subsequent `Group`s)
25+
- `Message::id` has moved to `Title::id`
26+
- Renamed `Renderer::line_no` to `Renderer::line_num`
27+
28+
### Features
29+
30+
- Added unicode decor support, see `renderer::DecorStyle`
31+
- Created [`Group`] to indicate what all is included between the unicode begin and end decor
32+
- Added `Level::secondary_title` to allow for custom ANSI escape code styling to be applied to those `Title`s
33+
- Added `AnnotationKind::Visible` to force spans to be visible within a Snippet, despite code folding, without any visible marker
34+
- Added `Origin` for referencing code without the source
35+
- Added `Group::with_level` to allow `Snippet`s without a `Title`
36+
- Added `Level::no_name` to hide the level name
37+
- Added `Level::with_name` to override what is rendered for that level
38+
- Added `Title::id_url` to turn `Title::id` into a link
39+
- Added `Patch` for displaying changes to code
40+
41+
### Fixes
42+
43+
- Switched strings to `Cow<str>` to allow for easier management of owned data
44+
- `Snippet::path` now accepts `None`
45+
- `Annotation::label` now accepts `None`
46+
- Various rendering fixes
47+
1048
## [0.11.5] - 2024-12-09
1149

1250
### Added

0 commit comments

Comments
 (0)