annotate-snippets is a Rust library for annotation of programming code slices.
The library helps visualize meta information annotating source code slices.
It takes a data structure called Snippet on the input and produces a String
which may look like this:
text
error[E0308]: mismatched types
--> src/format.rs:52:1
|
51 | ) -> Option<String> {
| -------------- expected `Option<String>` because of return type
52 | / for ann in annotations {
53 | | match (ann.range.0, ann.range.1) {
54 | | (None, None) => continue,
55 | | (Some(start), Some(end)) if start > end_index => continue,
... |
71 | | }
72 | | }
| |_____^ expected enum `std::option::Option`, found ()
```rust use annotatesnippets::{ displaylist::{DisplayList, FormatOptions}, snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation}, };
fn main() {
let snippet = Snippet {
title: Some(Annotation {
label: Some("expected type, found 22"),
id: None,
annotationtype: AnnotationType::Error,
}),
footer: vec![],
slices: vec![Slice {
source: r#" annotations: vec![SourceAnnotation {
label: "expected struct annotate_snippets::snippet::Slice, found reference"
,
range: <22, 25>,"#,
linestart: 26,
origin: Some("examples/footer.rs"),
fold: true,
annotations: vec![
SourceAnnotation {
label: "",
annotationtype: AnnotationType::Error,
range: (205, 207),
},
SourceAnnotation {
label: "while parsing this struct",
annotationtype: AnnotationType::Info,
range: (34, 50),
},
],
}],
opt: FormatOptions {
color: true,
..Default::default()
},
};
let dl = DisplayList::from(snippet);
println!("{}", dl);
} ```
cargo build
cargo test
When submitting a PR please use [cargo fmt][] (nightly).