Skip to content

Commit b49f947

Browse files
epageepage
committed
fix!: Rename AnnotationType to Level
1 parent 87bc645 commit b49f947

14 files changed

+70
-88
lines changed

‎src/renderer/display_list.rs

Lines changed: 20 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -649,14 +649,14 @@ pub enum DisplayAnnotationType {
649649
Help,
650650
}
651651

652-
impl From<snippet::AnnotationType> for DisplayAnnotationType {
653-
fn from(at: snippet::AnnotationType) -> Self {
652+
impl From<snippet::Level> for DisplayAnnotationType {
653+
fn from(at: snippet::Level) -> Self {
654654
match at {
655-
snippet::AnnotationType::Error => DisplayAnnotationType::Error,
656-
snippet::AnnotationType::Warning => DisplayAnnotationType::Warning,
657-
snippet::AnnotationType::Info => DisplayAnnotationType::Info,
658-
snippet::AnnotationType::Note => DisplayAnnotationType::Note,
659-
snippet::AnnotationType::Help => DisplayAnnotationType::Help,
655+
snippet::Level::Error => DisplayAnnotationType::Error,
656+
snippet::Level::Warning => DisplayAnnotationType::Warning,
657+
snippet::Level::Info => DisplayAnnotationType::Info,
658+
snippet::Level::Note => DisplayAnnotationType::Note,
659+
snippet::Level::Help => DisplayAnnotationType::Help,
660660
}
661661
}
662662
}
@@ -736,7 +736,7 @@ fn format_label(
736736
fn format_title<'a>(title: snippet::Label<'a>, id: Option<&'a str>) -> DisplayLine<'a> {
737737
DisplayLine::Raw(DisplayRawLine::Annotation {
738738
annotation: Annotation {
739-
annotation_type: DisplayAnnotationType::from(title.annotation_type),
739+
annotation_type: DisplayAnnotationType::from(title.level),
740740
id,
741741
label: format_label(Some(title.label), Some(DisplayTextStyle::Emphasis)),
742742
},
@@ -750,7 +750,7 @@ fn format_footer(footer: snippet::Label<'_>) -> Vec<DisplayLine<'_>> {
750750
for (i, line) in footer.label.lines().enumerate() {
751751
result.push(DisplayLine::Raw(DisplayRawLine::Annotation {
752752
annotation: Annotation {
753-
annotation_type: DisplayAnnotationType::from(footer.annotation_type),
753+
annotation_type: DisplayAnnotationType::from(footer.level),
754754
id: None,
755755
label: format_label(Some(line), None),
756756
},
@@ -1010,10 +1010,10 @@ fn format_body(
10101010
// It would be nice to use filter_drain here once it's stable.
10111011
annotations.retain(|annotation| {
10121012
let body_idx = idx + annotation_line_count;
1013-
let annotation_type = match annotation.annotation_type {
1014-
snippet::AnnotationType::Error => DisplayAnnotationType::None,
1015-
snippet::AnnotationType::Warning => DisplayAnnotationType::None,
1016-
_ => DisplayAnnotationType::from(annotation.annotation_type),
1013+
let annotation_type = match annotation.level {
1014+
snippet::Level::Error => DisplayAnnotationType::None,
1015+
snippet::Level::Warning => DisplayAnnotationType::None,
1016+
_ => DisplayAnnotationType::from(annotation.level),
10171017
};
10181018
match annotation.range {
10191019
Range { start, .. } if start > line_end_index => true,
@@ -1036,9 +1036,7 @@ fn format_body(
10361036
label: format_label(Some(annotation.label), None),
10371037
},
10381038
range,
1039-
annotation_type: DisplayAnnotationType::from(
1040-
annotation.annotation_type,
1041-
),
1039+
annotation_type: DisplayAnnotationType::from(annotation.level),
10421040
annotation_part: DisplayAnnotationPart::Standalone,
10431041
},
10441042
},
@@ -1059,9 +1057,7 @@ fn format_body(
10591057
{
10601058
inline_marks.push(DisplayMark {
10611059
mark_type: DisplayMarkType::AnnotationStart,
1062-
annotation_type: DisplayAnnotationType::from(
1063-
annotation.annotation_type,
1064-
),
1060+
annotation_type: DisplayAnnotationType::from(annotation.level),
10651061
});
10661062
}
10671063
} else {
@@ -1079,9 +1075,7 @@ fn format_body(
10791075
label: vec![],
10801076
},
10811077
range,
1082-
annotation_type: DisplayAnnotationType::from(
1083-
annotation.annotation_type,
1084-
),
1078+
annotation_type: DisplayAnnotationType::from(annotation.level),
10851079
annotation_part: DisplayAnnotationPart::MultilineStart,
10861080
},
10871081
},
@@ -1098,9 +1092,7 @@ fn format_body(
10981092
{
10991093
inline_marks.push(DisplayMark {
11001094
mark_type: DisplayMarkType::AnnotationThrough,
1101-
annotation_type: DisplayAnnotationType::from(
1102-
annotation.annotation_type,
1103-
),
1095+
annotation_type: DisplayAnnotationType::from(annotation.level),
11041096
});
11051097
}
11061098
true
@@ -1117,9 +1109,7 @@ fn format_body(
11171109
{
11181110
inline_marks.push(DisplayMark {
11191111
mark_type: DisplayMarkType::AnnotationThrough,
1120-
annotation_type: DisplayAnnotationType::from(
1121-
annotation.annotation_type,
1122-
),
1112+
annotation_type: DisplayAnnotationType::from(annotation.level),
11231113
});
11241114
}
11251115

@@ -1131,9 +1121,7 @@ fn format_body(
11311121
lineno: None,
11321122
inline_marks: vec![DisplayMark {
11331123
mark_type: DisplayMarkType::AnnotationThrough,
1134-
annotation_type: DisplayAnnotationType::from(
1135-
annotation.annotation_type,
1136-
),
1124+
annotation_type: DisplayAnnotationType::from(annotation.level),
11371125
}],
11381126
line: DisplaySourceLine::Annotation {
11391127
annotation: Annotation {
@@ -1142,9 +1130,7 @@ fn format_body(
11421130
label: format_label(Some(annotation.label), None),
11431131
},
11441132
range,
1145-
annotation_type: DisplayAnnotationType::from(
1146-
annotation.annotation_type,
1147-
),
1133+
annotation_type: DisplayAnnotationType::from(annotation.level),
11481134
annotation_part: DisplayAnnotationPart::MultilineEnd,
11491135
},
11501136
},

‎src/snippet.rs

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -67,35 +67,32 @@ impl<'a> Snippet<'a> {
6767
}
6868

6969
pub struct Label<'a> {
70-
pub(crate) annotation_type: AnnotationType,
70+
pub(crate) level: Level,
7171
pub(crate) label: &'a str,
7272
}
7373

7474
impl<'a> Label<'a> {
75-
pub fn new(annotation_type: AnnotationType, label: &'a str) -> Self {
76-
Self {
77-
annotation_type,
78-
label,
79-
}
75+
pub fn new(level: Level, label: &'a str) -> Self {
76+
Self { level, label }
8077
}
8178
pub fn error(label: &'a str) -> Self {
82-
Self::new(AnnotationType::Error, label)
79+
Self::new(Level::Error, label)
8380
}
8481

8582
pub fn warning(label: &'a str) -> Self {
86-
Self::new(AnnotationType::Warning, label)
83+
Self::new(Level::Warning, label)
8784
}
8885

8986
pub fn info(label: &'a str) -> Self {
90-
Self::new(AnnotationType::Info, label)
87+
Self::new(Level::Info, label)
9188
}
9289

9390
pub fn note(label: &'a str) -> Self {
94-
Self::new(AnnotationType::Note, label)
91+
Self::new(Level::Note, label)
9592
}
9693

9794
pub fn help(label: &'a str) -> Self {
98-
Self::new(AnnotationType::Help, label)
95+
Self::new(Level::Help, label)
9996
}
10097

10198
pub fn label(mut self, label: &'a str) -> Self {
@@ -108,7 +105,7 @@ impl<'a> Label<'a> {
108105
SourceAnnotation {
109106
range: span,
110107
label: self.label,
111-
annotation_type: self.annotation_type,
108+
level: self.level,
112109
}
113110
}
114111
}
@@ -155,7 +152,7 @@ impl<'a> Slice<'a> {
155152

156153
/// Types of annotations.
157154
#[derive(Debug, Clone, Copy, PartialEq)]
158-
pub enum AnnotationType {
155+
pub enum Level {
159156
/// Error annotations are displayed using red color and "^" character.
160157
Error,
161158
/// Warning annotations are displayed using blue color and "-" character.
@@ -173,5 +170,5 @@ pub struct SourceAnnotation<'a> {
173170
/// The byte range of the annotation in the `source` string
174171
pub(crate) range: Range<usize>,
175172
pub(crate) label: &'a str,
176-
pub(crate) annotation_type: AnnotationType,
173+
pub(crate) level: Level,
177174
}

‎tests/fixtures/deserialize.rs

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use serde::{Deserialize, Deserializer, Serialize};
22
use std::ops::Range;
33

44
use annotate_snippets::{
5-
renderer::Margin, AnnotationType, Label, Renderer, Slice, Snippet, SourceAnnotation,
5+
renderer::Margin, Label, Level, Renderer, Slice, Snippet, SourceAnnotation,
66
};
77

88
#[derive(Deserialize)]
@@ -63,8 +63,7 @@ where
6363
LabelDef<'a>,
6464
);
6565

66-
Wrapper::deserialize(deserializer)
67-
.map(|Wrapper(label)| Label::new(label.annotation_type, label.label))
66+
Wrapper::deserialize(deserializer).map(|Wrapper(label)| Label::new(label.level, label.label))
6867
}
6968

7069
fn deserialize_labels<'de, D>(deserializer: D) -> Result<Vec<Label<'de>>, D::Error>
@@ -80,7 +79,7 @@ where
8079

8180
let v = Vec::deserialize(deserializer)?;
8281
Ok(v.into_iter()
83-
.map(|Wrapper(a)| Label::new(a.annotation_type, a.label))
82+
.map(|Wrapper(a)| Label::new(a.level, a.label))
8483
.collect())
8584
}
8685

@@ -151,33 +150,33 @@ pub struct SourceAnnotationDef<'a> {
151150
pub range: Range<usize>,
152151
#[serde(borrow)]
153152
pub label: &'a str,
154-
#[serde(with = "AnnotationTypeDef")]
155-
pub annotation_type: AnnotationType,
153+
#[serde(with = "LevelDef")]
154+
pub level: Level,
156155
}
157156

158157
impl<'a> From<SourceAnnotationDef<'a>> for SourceAnnotation<'a> {
159158
fn from(val: SourceAnnotationDef<'a>) -> Self {
160159
let SourceAnnotationDef {
161160
range,
162161
label,
163-
annotation_type,
162+
level,
164163
} = val;
165-
Label::new(annotation_type, label).span(range)
164+
Label::new(level, label).span(range)
166165
}
167166
}
168167

169168
#[derive(Serialize, Deserialize)]
170169
pub struct LabelDef<'a> {
171-
#[serde(with = "AnnotationTypeDef")]
172-
pub annotation_type: AnnotationType,
170+
#[serde(with = "LevelDef")]
171+
pub level: Level,
173172
#[serde(borrow)]
174173
pub label: &'a str,
175174
}
176175

177176
#[allow(dead_code)]
178177
#[derive(Serialize, Deserialize)]
179-
#[serde(remote = "AnnotationType")]
180-
enum AnnotationTypeDef {
178+
#[serde(remote = "Level")]
179+
enum LevelDef {
181180
Error,
182181
Warning,
183182
Info,

‎tests/fixtures/no-color/issue_52.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[snippet.title]
2-
annotation_type = "Error"
2+
level = "Error"
33
label = ""
44

55
[[snippet.slices]]
@@ -13,5 +13,5 @@ origin = "path/to/error.rs"
1313
fold = true
1414
[[snippet.slices.annotations]]
1515
label = "error here"
16-
annotation_type = "Warning"
16+
level = "Warning"
1717
range = [2,16]

‎tests/fixtures/no-color/issue_9.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
[snippet.title]
22
label = "expected one of `.`, `;`, `?`, or an operator, found `for`"
3-
annotation_type = "Error"
3+
level = "Error"
44

55
[[snippet.slices]]
66
source = "let x = vec![1];"
77
line_start = 4
88
origin = "/code/rust/src/test/ui/annotate-snippet/suggestion.rs"
99
[[snippet.slices.annotations]]
1010
label = "move occurs because `x` has type `std::vec::Vec<i32>`, which does not implement the `Copy` trait"
11-
annotation_type = "Warning"
11+
level = "Warning"
1212
range = [4, 5]
1313

1414
[[snippet.slices]]
1515
source = "let y = x;"
1616
line_start = 7
1717
[[snippet.slices.annotations]]
1818
label = "value moved here"
19-
annotation_type = "Warning"
19+
level = "Warning"
2020
range = [8, 9]
2121

2222
[[snippet.slices]]
2323
source = "x;"
2424
line_start = 9
2525
[[snippet.slices.annotations]]
2626
label = "value used here after move"
27-
annotation_type = "Error"
27+
level = "Error"
2828
range = [0, 1]

‎tests/fixtures/no-color/multiline_annotation.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ origin = "src/format.rs"
2828
fold = true
2929
[[snippet.slices.annotations]]
3030
label = "expected `std::option::Option<std::string::String>` because of return type"
31-
annotation_type = "Warning"
31+
level = "Warning"
3232
range = [5, 19]
3333
[[snippet.slices.annotations]]
3434
label = "expected enum `std::option::Option`, found ()"
35-
annotation_type = "Error"
35+
level = "Error"
3636
range = [22, 766]
3737

3838
[snippet]
39-
title = { annotation_type = "Error", label = "mismatched types" }
39+
title = { level = "Error", label = "mismatched types" }
4040
id = "E0308"

‎tests/fixtures/no-color/multiline_annotation2.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ origin = "src/display_list.rs"
99
fold = false
1010
[[snippet.slices.annotations]]
1111
label = "missing fields `lineno`, `content`"
12-
annotation_type = "Error"
12+
level = "Error"
1313
range = [31, 128]
1414

1515
[snippet]
16-
title = { annotation_type = "Error", label = "pattern does not mention fields `lineno`, `content`" }
16+
title = { level = "Error", label = "pattern does not mention fields `lineno`, `content`" }
1717
id = "E0027"

‎tests/fixtures/no-color/multiline_annotation3.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ origin = "foo.txt"
99
fold = false
1010
[[snippet.slices.annotations]]
1111
label = "this should not be on separate lines"
12-
annotation_type = "Error"
12+
level = "Error"
1313
range = [11, 18]
1414

1515
[snippet]
16-
title = { annotation_type = "Error", label = "spacing error found" }
16+
title = { level = "Error", label = "spacing error found" }
1717
id = "E####"

‎tests/fixtures/no-color/multiple_annotations.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[snippet.title]
2-
annotation_type = "Error"
2+
level = "Error"
33
label = ""
44

55
[[snippet.slices]]
@@ -17,13 +17,13 @@ fn add_title_line(result: &mut Vec<String>, main_annotation: Option<&Annotation>
1717
line_start = 96
1818
[[snippet.slices.annotations]]
1919
label = "Variable defined here"
20-
annotation_type = "Error"
20+
level = "Error"
2121
range = [100, 110]
2222
[[snippet.slices.annotations]]
2323
label = "Referenced here"
24-
annotation_type = "Error"
24+
level = "Error"
2525
range = [184, 194]
2626
[[snippet.slices.annotations]]
2727
label = "Referenced again here"
28-
annotation_type = "Error"
28+
level = "Error"
2929
range = [243, 253]

‎tests/fixtures/no-color/one_past.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[snippet.title]
22
label = "expected `.`, `=`"
3-
annotation_type = "Error"
3+
level = "Error"
44

55
[[snippet.slices]]
66
source = "asdf"
77
line_start = 1
88
origin = "Cargo.toml"
99
[[snippet.slices.annotations]]
1010
label = ""
11-
annotation_type = "Error"
11+
level = "Error"
1212
range = [4, 5]

0 commit comments

Comments
 (0)