Add more tests to the formatter and some documentation

Author: Zibi Braniecki

examples/expected_type.rs

@@ -12,27 +12,29 @@ fn main() {
             annotation_type: AnnotationType::Error,
         }),
         footer: vec![],
-        slices: vec![Slice {
-            source: r#"                annotations: vec![SourceAnnotation {
+        slices: vec![
+            Slice {
+                source: r#"                annotations: vec![SourceAnnotation {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                     .to_string(),
                 range: <22, 25>,"#.to_string(),
-            line_start: 26,
-            origin: Some("examples/footer.rs".to_string()),
-            fold: true,
-            annotations: vec![
-                SourceAnnotation {
-                    label: "".to_string(),
-                    annotation_type: AnnotationType::Error,
-                    range: (208, 210),
-                },
-                SourceAnnotation {
-                    label: "while parsing this struct".to_string(),
-                    annotation_type: AnnotationType::Info,
-                    range: (34, 50),
-                },
-            ],
-        }],
+                line_start: 26,
+                origin: Some("examples/footer.rs".to_string()),
+                fold: true,
+                annotations: vec![
+                    SourceAnnotation {
+                        label: "".to_string(),
+                        annotation_type: AnnotationType::Error,
+                        range: (208, 210),
+                    },
+                    SourceAnnotation {
+                        label: "while parsing this struct".to_string(),
+                        annotation_type: AnnotationType::Info,
+                        range: (34, 50),
+                    },
+                ],
+            },
+        ],
     };
 
     let dl = DisplayList::from(snippet);

examples/footer.rs

@@ -5,33 +5,36 @@ use annotate_snippets::formatter::DisplayListFormatter;
 use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation};
 
 fn main() {
-    let snippet = Snippet {
-        title: Some(Annotation {
-            label: Some("mismatched types".to_string()),
-            id: Some("E0308".to_string()),
-            annotation_type: AnnotationType::Error,
-        }),
-        footer: vec![Annotation {
+    let snippet =
+        Snippet {
+            title: Some(Annotation {
+                label: Some("mismatched types".to_string()),
+                id: Some("E0308".to_string()),
+                annotation_type: AnnotationType::Error,
+            }),
+            footer: vec![Annotation {
             label: Some(
                 "expected type: `snippet::Annotation`\n   found type: `__&__snippet::Annotation`"
                     .to_string(),
             ),
             id: None,
             annotation_type: AnnotationType::Note,
         }],
-        slices: vec![Slice {
-            source: "        slices: vec![\"A\",".to_string(),
-            line_start: 13,
-            origin: Some("src/multislice.rs".to_string()),
-            fold: false,
-            annotations: vec![SourceAnnotation {
+            slices: vec![
+                Slice {
+                    source: "        slices: vec![\"A\",".to_string(),
+                    line_start: 13,
+                    origin: Some("src/multislice.rs".to_string()),
+                    fold: false,
+                    annotations: vec![SourceAnnotation {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                     .to_string(),
                 range: (21, 24),
                 annotation_type: AnnotationType::Error,
             }],
-        }],
-    };
+                },
+            ],
+        };
 
     let dl = DisplayList::from(snippet);
     let dlf = DisplayListFormatter::new(true);

examples/format.rs

@@ -6,8 +6,9 @@ use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, Sou
 
 fn main() {
     let snippet = Snippet {
-        slices: vec![Slice {
-            source: r#") -> Option<String> {
+        slices: vec![
+            Slice {
+                source: r#") -> Option<String> {
     for ann in annotations {
         match (ann.range.0, ann.range.1) {
             (None, None) => continue,
@@ -29,22 +30,23 @@ fn main() {
             _ => continue,
         }
     }"#.to_string(),
-            line_start: 51,
-            origin: Some("src/format.rs".to_string()),
-            fold: false,
-            annotations: vec![
-                SourceAnnotation {
-                    label: "expected `Option<String>` because of return type".to_string(),
-                    annotation_type: AnnotationType::Warning,
-                    range: (5, 19),
-                },
-                SourceAnnotation {
-                    label: "expected enum `std::option::Option`".to_string(),
-                    annotation_type: AnnotationType::Error,
-                    range: (23, 745),
-                },
-            ],
-        }],
+                line_start: 51,
+                origin: Some("src/format.rs".to_string()),
+                fold: false,
+                annotations: vec![
+                    SourceAnnotation {
+                        label: "expected `Option<String>` because of return type".to_string(),
+                        annotation_type: AnnotationType::Warning,
+                        range: (5, 19),
+                    },
+                    SourceAnnotation {
+                        label: "expected enum `std::option::Option`".to_string(),
+                        annotation_type: AnnotationType::Error,
+                        range: (23, 745),
+                    },
+                ],
+            },
+        ],
         title: Some(Annotation {
             label: Some("mismatched types".to_string()),
             id: Some("E0308".to_string()),

src/display_list/from_snippet.rs

@@ -307,12 +307,14 @@ fn format_body(slice: &snippet::Slice, has_footer: bool) -> Vec<DisplayLine> {
                         body_idx + 1,
                         DisplayLine::Source {
                             lineno: None,
-                            inline_marks: vec![DisplayMark {
-                                mark_type: DisplayMarkType::AnnotationThrough,
-                                annotation_type: DisplayAnnotationType::from(
-                                    annotation.annotation_type,
-                                ),
-                            }],
+                            inline_marks: vec![
+                                DisplayMark {
+                                    mark_type: DisplayMarkType::AnnotationThrough,
+                                    annotation_type: DisplayAnnotationType::from(
+                                        annotation.annotation_type,
+                                    ),
+                                },
+                            ],
                             line: DisplaySourceLine::Annotation {
                                 annotation: Annotation {
                                     annotation_type,

tests/dl_from_snippet.rs

@@ -15,18 +15,22 @@ fn test_format_title() {
         slices: vec![],
     };
     let output = dl::DisplayList {
-        body: vec![dl::DisplayLine::Raw(dl::DisplayRawLine::Annotation {
-            annotation: dl::Annotation {
-                annotation_type: dl::DisplayAnnotationType::Error,
-                id: Some("E0001".to_string()),
-                label: vec![dl::DisplayTextFragment {
-                    content: "This is a title".to_string(),
-                    style: dl::DisplayTextStyle::Emphasis,
-                }],
-            },
-            source_aligned: false,
-            continuation: false,
-        })],
+        body: vec![
+            dl::DisplayLine::Raw(dl::DisplayRawLine::Annotation {
+                annotation: dl::Annotation {
+                    annotation_type: dl::DisplayAnnotationType::Error,
+                    id: Some("E0001".to_string()),
+                    label: vec![
+                        dl::DisplayTextFragment {
+                            content: "This is a title".to_string(),
+                            style: dl::DisplayTextStyle::Emphasis,
+                        },
+                    ],
+                },
+                source_aligned: false,
+                continuation: false,
+            }),
+        ],
     };
     assert_eq!(dl::DisplayList::from(input), output);
 }
@@ -36,13 +40,15 @@ fn test_format_slice() {
     let input = snippet::Snippet {
         title: None,
         footer: vec![],
-        slices: vec![snippet::Slice {
-            source: "This is line 1\nThis is line 2".to_string(),
-            line_start: 5402,
-            origin: None,
-            annotations: vec![],
-            fold: false,
-        }],
+        slices: vec![
+            snippet::Slice {
+                source: "This is line 1\nThis is line 2".to_string(),
+                line_start: 5402,
+                origin: None,
+                annotations: vec![],
+                fold: false,
+            },
+        ],
     };
     let output = dl::DisplayList {
         body: vec![
@@ -82,17 +88,21 @@ fn test_format_slice_annotation_standalone() {
     let input = snippet::Snippet {
         title: None,
         footer: vec![],
-        slices: vec![snippet::Slice {
-            source: "This is line 1\nThis is line 2".to_string(),
-            line_start: 5402,
-            origin: None,
-            annotations: vec![snippet::SourceAnnotation {
-                range: (22, 24),
-                label: "Test annotation".to_string(),
-                annotation_type: snippet::AnnotationType::Info,
-            }],
-            fold: false,
-        }],
+        slices: vec![
+            snippet::Slice {
+                source: "This is line 1\nThis is line 2".to_string(),
+                line_start: 5402,
+                origin: None,
+                annotations: vec![
+                    snippet::SourceAnnotation {
+                        range: (22, 24),
+                        label: "Test annotation".to_string(),
+                        annotation_type: snippet::AnnotationType::Info,
+                    },
+                ],
+                fold: false,
+            },
+        ],
     };
     let output = dl::DisplayList {
         body: vec![
@@ -124,10 +134,12 @@ fn test_format_slice_annotation_standalone() {
                     annotation: dl::Annotation {
                         annotation_type: dl::DisplayAnnotationType::Info,
                         id: None,
-                        label: vec![dl::DisplayTextFragment {
-                            content: "Test annotation".to_string(),
-                            style: dl::DisplayTextStyle::Regular,
-                        }],
+                        label: vec![
+                            dl::DisplayTextFragment {
+                                content: "Test annotation".to_string(),
+                                style: dl::DisplayTextStyle::Regular,
+                            },
+                        ],
                     },
                     range: (6, 8),
                     annotation_type: dl::DisplayAnnotationType::Info,

tests/fixtures.rs

@@ -1,10 +1,10 @@
 mod diff;
 mod snippet;
 
-#[macro_use]
-extern crate serde_derive;
 extern crate annotate_snippets;
 extern crate glob;
+#[macro_use]
+extern crate serde_derive;
 extern crate serde_yaml;
 
 use annotate_snippets::display_list::DisplayList;