Skip to content

Commit b821bd3

Browse files
epageepage
committed
fix!: Default Snippet::line_start
1 parent 91bd796 commit b821bd3

File tree

10 files changed

+45
-24
lines changed

10 files changed

+45
-24
lines changed

‎benches/simple.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ fn create_snippet(renderer: Renderer) {
3030
}
3131
}"#;
3232
let message = Message::error("mismatched types").id("E0308").snippet(
33-
Snippet::new(source, 51)
33+
Snippet::new(source)
34+
.line_start(51)
3435
.origin("src/format.rs")
3536
.annotation(
3637
Label::warning("expected `Option<String>` because of return type").span(5..19),

‎examples/expected_type.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ fn main() {
66
,
77
range: <22, 25>,"#;
88
let message = Message::error("expected type, found `22`").snippet(
9-
Snippet::new(source, 26)
9+
Snippet::new(source)
10+
.line_start(26)
1011
.origin("examples/footer.rs")
1112
.fold(true)
1213
.annotation(

‎examples/footer.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ fn main() {
44
let message = Message::error("mismatched types")
55
.id("E0308")
66
.snippet(
7-
Snippet::new(" slices: vec![\"A\",", 13)
7+
Snippet::new(" slices: vec![\"A\",")
8+
.line_start(13)
89
.origin("src/multislice.rs")
910
.annotation(
1011
Label::error(

‎examples/format.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ fn main() {
2424
}
2525
}"#;
2626
let message = Message::error("mismatched types").id("E0308").snippet(
27-
Snippet::new(source, 51)
27+
Snippet::new(source)
28+
.line_start(51)
2829
.origin("src/format.rs")
2930
.annotation(
3031
Label::warning("expected `Option<String>` because of return type").span(5..19),

‎examples/multislice.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ use annotate_snippets::{Message, Renderer, Snippet};
22

33
fn main() {
44
let message = Message::error("mismatched types")
5-
.snippet(Snippet::new("Foo", 51).origin("src/format.rs"))
6-
.snippet(Snippet::new("Faa", 129).origin("src/display.rs"));
5+
.snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
6+
.snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
77

88
let renderer = Renderer::styled();
99
anstream::println!("{}", renderer.render(message));

‎src/renderer/display_list.rs‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1227,7 +1227,8 @@ mod tests {
12271227
let line_1 = "This is line 1";
12281228
let line_2 = "This is line 2";
12291229
let source = [line_1, line_2].join("\n");
1230-
let input = snippet::Message::error("").snippet(snippet::Snippet::new(&source, 5402));
1230+
let input =
1231+
snippet::Message::error("").snippet(snippet::Snippet::new(&source).line_start(5402));
12311232
let output = from_display_lines(vec![
12321233
DisplayLine::Raw(DisplayRawLine::Annotation {
12331234
annotation: Annotation {
@@ -1278,8 +1279,16 @@ mod tests {
12781279
let src_1 = "This is slice 2";
12791280
let src_1_len = src_1.len();
12801281
let input = snippet::Message::error("")
1281-
.snippet(snippet::Snippet::new(src_0, 5402).origin("file1.rs"))
1282-
.snippet(snippet::Snippet::new(src_1, 2).origin("file2.rs"));
1282+
.snippet(
1283+
snippet::Snippet::new(src_0)
1284+
.line_start(5402)
1285+
.origin("file1.rs"),
1286+
)
1287+
.snippet(
1288+
snippet::Snippet::new(src_1)
1289+
.line_start(2)
1290+
.origin("file2.rs"),
1291+
);
12831292
let output = from_display_lines(vec![
12841293
DisplayLine::Raw(DisplayRawLine::Annotation {
12851294
annotation: Annotation {
@@ -1351,7 +1360,8 @@ mod tests {
13511360
// In line 2
13521361
let range = 22..24;
13531362
let input = snippet::Message::error("").snippet(
1354-
snippet::Snippet::new(&source, 5402)
1363+
snippet::Snippet::new(&source)
1364+
.line_start(5402)
13551365
.annotation(snippet::Label::info("Test annotation").span(range.clone())),
13561366
);
13571367
let output = from_display_lines(vec![
@@ -1456,7 +1466,8 @@ mod tests {
14561466
let source = "short";
14571467
let label = "label";
14581468
let input = snippet::Message::error("").snippet(
1459-
snippet::Snippet::new(source, 0)
1469+
snippet::Snippet::new(source)
1470+
.line_start(0)
14601471
.annotation(snippet::Label::error(label).span(0..source.len() + 2)),
14611472
);
14621473
let _ = DisplayList::new(input, &STYLESHEET, false, None);
@@ -1465,7 +1476,8 @@ mod tests {
14651476
#[test]
14661477
fn test_i_29() {
14671478
let snippets = snippet::Message::error("oops").snippet(
1468-
snippet::Snippet::new("First line\r\nSecond oops line", 1)
1479+
snippet::Snippet::new("First line\r\nSecond oops line")
1480+
.line_start(1)
14691481
.origin("<current file>")
14701482
.fold(true)
14711483
.annotation(snippet::Label::error("oops").span(19..23)),

‎src/renderer/mod.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
//! ```
55
//! use annotate_snippets::{Renderer, Snippet, Message};
66
//! let snippet = Message::error("mismatched types")
7-
//! .snippet(Snippet::new("Foo", 51).origin("src/format.rs"))
8-
//! .snippet(Snippet::new("Faa", 129).origin("src/display.rs"));
7+
//! .snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
8+
//! .snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
99
//!
1010
//! let renderer = Renderer::styled();
1111
//! println!("{}", renderer.render(snippet));

‎src/snippet.rs‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
//! use annotate_snippets::*;
77
//!
88
//! Message::error("mismatched types")
9-
//! .snippet(Snippet::new("Foo", 51).origin("src/format.rs"))
10-
//! .snippet(Snippet::new("Faa", 129).origin("src/display.rs"));
9+
//! .snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
10+
//! .snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
1111
//! ```
1212
1313
use std::ops::Range;
@@ -126,16 +126,21 @@ pub struct Snippet<'a> {
126126
}
127127

128128
impl<'a> Snippet<'a> {
129-
pub fn new(source: &'a str, line_start: usize) -> Self {
129+
pub fn new(source: &'a str) -> Self {
130130
Self {
131131
origin: None,
132-
line_start,
132+
line_start: 1,
133133
source,
134134
annotations: vec![],
135135
fold: false,
136136
}
137137
}
138138

139+
pub fn line_start(mut self, line_start: usize) -> Self {
140+
self.line_start = line_start;
141+
self
142+
}
143+
139144
pub fn origin(mut self, origin: &'a str) -> Self {
140145
self.origin = Some(origin);
141146
self

‎tests/fixtures/deserialize.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ impl<'a> From<SnippetDef<'a>> for Snippet<'a> {
119119
annotations,
120120
fold,
121121
} = val;
122-
let mut snippet = Snippet::new(source, line_start).fold(fold);
122+
let mut snippet = Snippet::new(source).line_start(line_start).fold(fold);
123123
if let Some(origin) = origin {
124124
snippet = snippet.origin(origin)
125125
}

‎tests/formatter.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use annotate_snippets::{Label, Message, Renderer, Snippet};
33
#[test]
44
fn test_i_29() {
55
let snippets = Message::error("oops").snippet(
6-
Snippet::new("First line\r\nSecond oops line", 1)
6+
Snippet::new("First line\r\nSecond oops line")
77
.origin("<current file>")
88
.annotation(Label::error("oops").span(19..23))
99
.fold(true),
@@ -23,7 +23,7 @@ fn test_i_29() {
2323
#[test]
2424
fn test_point_to_double_width_characters() {
2525
let snippets = Message::error("").snippet(
26-
Snippet::new("こんにちは、世界", 1)
26+
Snippet::new("こんにちは、世界")
2727
.origin("<current file>")
2828
.annotation(Label::error("world").span(12..16)),
2929
);
@@ -42,7 +42,7 @@ fn test_point_to_double_width_characters() {
4242
#[test]
4343
fn test_point_to_double_width_characters_across_lines() {
4444
let snippets = Message::error("").snippet(
45-
Snippet::new("おはよう\nございます", 1)
45+
Snippet::new("おはよう\nございます")
4646
.origin("<current file>")
4747
.annotation(Label::error("Good morning").span(4..15)),
4848
);
@@ -63,7 +63,7 @@ fn test_point_to_double_width_characters_across_lines() {
6363
#[test]
6464
fn test_point_to_double_width_characters_multiple() {
6565
let snippets = Message::error("").snippet(
66-
Snippet::new("お寿司\n食べたい🍣", 1)
66+
Snippet::new("お寿司\n食べたい🍣")
6767
.origin("<current file>")
6868
.annotation(Label::error("Sushi1").span(0..6))
6969
.annotation(Label::note("Sushi2").span(11..15)),
@@ -85,7 +85,7 @@ fn test_point_to_double_width_characters_multiple() {
8585
#[test]
8686
fn test_point_to_double_width_characters_mixed() {
8787
let snippets = Message::error("").snippet(
88-
Snippet::new("こんにちは、新しいWorld！", 1)
88+
Snippet::new("こんにちは、新しいWorld！")
8989
.origin("<current file>")
9090
.annotation(Label::error("New world").span(12..23)),
9191
);

0 commit comments

Comments
 (0)