1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# annotate-snippets
`annotate-snippets` is a Rust library for annotation of programming code slices.
[](https://crates.io/crates/annotate-snippets)
[](https://travis-ci.com/rust-lang/annotate-snippets-rs)
[](https://coveralls.io/github/rust-lang/annotate-snippets-rs?branch=master)
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 ()
```
[Documentation][]
[Documentation]: https://docs.rs/annotate-snippets/
Usage
-----
```rust
use annotate_snippets::{
display_list::DisplayList,
formatter::DisplayListFormatter,
snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
};
fn main() {
let snippet = Snippet {
title: Some(Annotation {
label: Some("expected type, found `22`".to_string()),
id: None,
annotation_type: AnnotationType::Error,
}),
footer: vec![],
slices: vec![
Slice {
source: r#"
This is an example
content of the slice
which will be annotated
with the list of annotations below.
"#.to_string(),
line_start: 26,
origin: Some("examples/example.txt".to_string()),
fold: false,
annotations: vec![
SourceAnnotation {
label: "Example error annotation".to_string(),
annotation_type: AnnotationType::Error,
range: (13, 18),
},
SourceAnnotation {
label: "and here's a warning".to_string(),
annotation_type: AnnotationType::Warning,
range: (34, 50),
},
],
},
],
};
let dl = DisplayList::from(snippet);
let dlf = DisplayListFormatter::new(true, false);
println!("{}", dlf.format(&dl));
}
```
Local Development
-----------------
cargo build
cargo test
When submitting a PR please use [`cargo fmt`][] (nightly).
[`cargo fmt`]: https://github.com/rust-lang/rustfmt
|
