Skip to content

Commit 5f39b53

Browse files
author
Zibi Braniecki
committed
Add more tests to the formatter and some documentation
1 parent bc17c26 commit 5f39b53

File tree

7 files changed

+386
-193
lines changed

7 files changed

+386
-193
lines changed

‎examples/expected_type.rs‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,29 @@ fn main() {
1212
annotation_type: AnnotationType::Error,
1313
}),
1414
footer: vec![],
15-
slices: vec![Slice {
16-
source: r#" annotations: vec![SourceAnnotation {
15+
slices: vec![
16+
Slice {
17+
source: r#" annotations: vec![SourceAnnotation {
1718
label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
1819
.to_string(),
1920
range: <22, 25>,"#.to_string(),
20-
line_start: 26,
21-
origin: Some("examples/footer.rs".to_string()),
22-
fold: true,
23-
annotations: vec![
24-
SourceAnnotation {
25-
label: "".to_string(),
26-
annotation_type: AnnotationType::Error,
27-
range: (208, 210),
28-
},
29-
SourceAnnotation {
30-
label: "while parsing this struct".to_string(),
31-
annotation_type: AnnotationType::Info,
32-
range: (34, 50),
33-
},
34-
],
35-
}],
21+
line_start: 26,
22+
origin: Some("examples/footer.rs".to_string()),
23+
fold: true,
24+
annotations: vec![
25+
SourceAnnotation {
26+
label: "".to_string(),
27+
annotation_type: AnnotationType::Error,
28+
range: (208, 210),
29+
},
30+
SourceAnnotation {
31+
label: "while parsing this struct".to_string(),
32+
annotation_type: AnnotationType::Info,
33+
range: (34, 50),
34+
},
35+
],
36+
},
37+
],
3638
};
3739

3840
let dl = DisplayList::from(snippet);

‎examples/footer.rs‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,36 @@ use annotate_snippets::formatter::DisplayListFormatter;
55
use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation};
66

77
fn main() {
8-
let snippet = Snippet {
9-
title: Some(Annotation {
10-
label: Some("mismatched types".to_string()),
11-
id: Some("E0308".to_string()),
12-
annotation_type: AnnotationType::Error,
13-
}),
14-
footer: vec![Annotation {
8+
let snippet =
9+
Snippet {
10+
title: Some(Annotation {
11+
label: Some("mismatched types".to_string()),
12+
id: Some("E0308".to_string()),
13+
annotation_type: AnnotationType::Error,
14+
}),
15+
footer: vec![Annotation {
1516
label: Some(
1617
"expected type: `snippet::Annotation`\n found type: `__&__snippet::Annotation`"
1718
.to_string(),
1819
),
1920
id: None,
2021
annotation_type: AnnotationType::Note,
2122
}],
22-
slices: vec![Slice {
23-
source: " slices: vec![\"A\",".to_string(),
24-
line_start: 13,
25-
origin: Some("src/multislice.rs".to_string()),
26-
fold: false,
27-
annotations: vec![SourceAnnotation {
23+
slices: vec![
24+
Slice {
25+
source: " slices: vec![\"A\",".to_string(),
26+
line_start: 13,
27+
origin: Some("src/multislice.rs".to_string()),
28+
fold: false,
29+
annotations: vec![SourceAnnotation {
2830
label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
2931
.to_string(),
3032
range: (21, 24),
3133
annotation_type: AnnotationType::Error,
3234
}],
33-
}],
34-
};
35+
},
36+
],
37+
};
3538

3639
let dl = DisplayList::from(snippet);
3740
let dlf = DisplayListFormatter::new(true);

‎examples/format.rs‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@ use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, Sou
66

77
fn main() {
88
let snippet = Snippet {
9-
slices: vec![Slice {
10-
source: r#") -> Option<String> {
9+
slices: vec![
10+
Slice {
11+
source: r#") -> Option<String> {
1112
for ann in annotations {
1213
match (ann.range.0, ann.range.1) {
1314
(None, None) => continue,
@@ -29,22 +30,23 @@ fn main() {
2930
_ => continue,
3031
}
3132
}"#.to_string(),
32-
line_start: 51,
33-
origin: Some("src/format.rs".to_string()),
34-
fold: false,
35-
annotations: vec![
36-
SourceAnnotation {
37-
label: "expected `Option<String>` because of return type".to_string(),
38-
annotation_type: AnnotationType::Warning,
39-
range: (5, 19),
40-
},
41-
SourceAnnotation {
42-
label: "expected enum `std::option::Option`".to_string(),
43-
annotation_type: AnnotationType::Error,
44-
range: (23, 745),
45-
},
46-
],
47-
}],
33+
line_start: 51,
34+
origin: Some("src/format.rs".to_string()),
35+
fold: false,
36+
annotations: vec![
37+
SourceAnnotation {
38+
label: "expected `Option<String>` because of return type".to_string(),
39+
annotation_type: AnnotationType::Warning,
40+
range: (5, 19),
41+
},
42+
SourceAnnotation {
43+
label: "expected enum `std::option::Option`".to_string(),
44+
annotation_type: AnnotationType::Error,
45+
range: (23, 745),
46+
},
47+
],
48+
},
49+
],
4850
title: Some(Annotation {
4951
label: Some("mismatched types".to_string()),
5052
id: Some("E0308".to_string()),

‎src/display_list/from_snippet.rs‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -307,12 +307,14 @@ fn format_body(slice: &snippet::Slice, has_footer: bool) -> Vec<DisplayLine> {
307307
body_idx + 1,
308308
DisplayLine::Source {
309309
lineno: None,
310-
inline_marks: vec![DisplayMark {
311-
mark_type: DisplayMarkType::AnnotationThrough,
312-
annotation_type: DisplayAnnotationType::from(
313-
annotation.annotation_type,
314-
),
315-
}],
310+
inline_marks: vec![
311+
DisplayMark {
312+
mark_type: DisplayMarkType::AnnotationThrough,
313+
annotation_type: DisplayAnnotationType::from(
314+
annotation.annotation_type,
315+
),
316+
},
317+
],
316318
line: DisplaySourceLine::Annotation {
317319
annotation: Annotation {
318320
annotation_type,

‎tests/dl_from_snippet.rs‎

Lines changed: 46 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,22 @@ fn test_format_title() {
1515
slices: vec![],
1616
};
1717
let output = dl::DisplayList {
18-
body: vec![dl::DisplayLine::Raw(dl::DisplayRawLine::Annotation {
19-
annotation: dl::Annotation {
20-
annotation_type: dl::DisplayAnnotationType::Error,
21-
id: Some("E0001".to_string()),
22-
label: vec![dl::DisplayTextFragment {
23-
content: "This is a title".to_string(),
24-
style: dl::DisplayTextStyle::Emphasis,
25-
}],
26-
},
27-
source_aligned: false,
28-
continuation: false,
29-
})],
18+
body: vec![
19+
dl::DisplayLine::Raw(dl::DisplayRawLine::Annotation {
20+
annotation: dl::Annotation {
21+
annotation_type: dl::DisplayAnnotationType::Error,
22+
id: Some("E0001".to_string()),
23+
label: vec![
24+
dl::DisplayTextFragment {
25+
content: "This is a title".to_string(),
26+
style: dl::DisplayTextStyle::Emphasis,
27+
},
28+
],
29+
},
30+
source_aligned: false,
31+
continuation: false,
32+
}),
33+
],
3034
};
3135
assert_eq!(dl::DisplayList::from(input), output);
3236
}
@@ -36,13 +40,15 @@ fn test_format_slice() {
3640
let input = snippet::Snippet {
3741
title: None,
3842
footer: vec![],
39-
slices: vec![snippet::Slice {
40-
source: "This is line 1\nThis is line 2".to_string(),
41-
line_start: 5402,
42-
origin: None,
43-
annotations: vec![],
44-
fold: false,
45-
}],
43+
slices: vec![
44+
snippet::Slice {
45+
source: "This is line 1\nThis is line 2".to_string(),
46+
line_start: 5402,
47+
origin: None,
48+
annotations: vec![],
49+
fold: false,
50+
},
51+
],
4652
};
4753
let output = dl::DisplayList {
4854
body: vec![
@@ -82,17 +88,21 @@ fn test_format_slice_annotation_standalone() {
8288
let input = snippet::Snippet {
8389
title: None,
8490
footer: vec![],
85-
slices: vec![snippet::Slice {
86-
source: "This is line 1\nThis is line 2".to_string(),
87-
line_start: 5402,
88-
origin: None,
89-
annotations: vec![snippet::SourceAnnotation {
90-
range: (22, 24),
91-
label: "Test annotation".to_string(),
92-
annotation_type: snippet::AnnotationType::Info,
93-
}],
94-
fold: false,
95-
}],
91+
slices: vec![
92+
snippet::Slice {
93+
source: "This is line 1\nThis is line 2".to_string(),
94+
line_start: 5402,
95+
origin: None,
96+
annotations: vec![
97+
snippet::SourceAnnotation {
98+
range: (22, 24),
99+
label: "Test annotation".to_string(),
100+
annotation_type: snippet::AnnotationType::Info,
101+
},
102+
],
103+
fold: false,
104+
},
105+
],
96106
};
97107
let output = dl::DisplayList {
98108
body: vec![
@@ -124,10 +134,12 @@ fn test_format_slice_annotation_standalone() {
124134
annotation: dl::Annotation {
125135
annotation_type: dl::DisplayAnnotationType::Info,
126136
id: None,
127-
label: vec![dl::DisplayTextFragment {
128-
content: "Test annotation".to_string(),
129-
style: dl::DisplayTextStyle::Regular,
130-
}],
137+
label: vec![
138+
dl::DisplayTextFragment {
139+
content: "Test annotation".to_string(),
140+
style: dl::DisplayTextStyle::Regular,
141+
},
142+
],
131143
},
132144
range: (6, 8),
133145
annotation_type: dl::DisplayAnnotationType::Info,

‎tests/fixtures.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
mod diff;
22
mod snippet;
33

4-
#[macro_use]
5-
extern crate serde_derive;
64
extern crate annotate_snippets;
75
extern crate glob;
6+
#[macro_use]
7+
extern crate serde_derive;
88
extern crate serde_yaml;
99

1010
use annotate_snippets::display_list::DisplayList;

0 commit comments

Comments
 (0)