Finalize colors and add a simple example

Author: Zibi Braniecki

examples/format.rs

@@ -1,7 +1,7 @@
 extern crate annotate_snippets;
 
-use annotate_snippets::snippet::{Snippet, Slice, Annotation, TitleAnnotation, AnnotationType};
 use annotate_snippets::display_list::DisplayList;
+use annotate_snippets::snippet::{Annotation, AnnotationType, Slice, Snippet, TitleAnnotation};
 
 fn main() {
     let snippet = Snippet {
@@ -28,28 +28,28 @@ fn main() {
             _ => continue,
         }
     }"#.to_string(),
-         line_start: 51,
-         origin: Some("src/format.rs".to_string())
-         },
-         title: Some(TitleAnnotation {
-             label: Some("mismatched types".to_string()),
-             id: Some("E0308".to_string()),
-             annotation_type: AnnotationType::Error,
-         }),
-         fold: Some(false),
-         annotations: vec![
-             Annotation {
-                 label: "expected `Option<String>` because of return type".to_string(),
-                 annotation_type: AnnotationType::Warning,
-                 range: (6, 20)
-             },
-             Annotation {
-                 label: "expected enum `std::option::Option".to_string(),
-                 annotation_type: AnnotationType::Error,
-                 range: (23, 746)
-             },
-         ]
-        };
+            line_start: 51,
+            origin: Some("src/format.rs".to_string()),
+        },
+        title: Some(TitleAnnotation {
+            label: Some("mismatched types".to_string()),
+            id: Some("E0308".to_string()),
+            annotation_type: AnnotationType::Error,
+        }),
+        fold: Some(true),
+        annotations: vec![
+            Annotation {
+                label: "expected `Option<String>` because of return type".to_string(),
+                annotation_type: AnnotationType::Warning,
+                range: (6, 20),
+            },
+            Annotation {
+                label: "expected enum `std::option::Option".to_string(),
+                annotation_type: AnnotationType::Error,
+                range: (23, 746),
+            },
+        ],
+    };
 
     println!("{}", DisplayList::from(snippet));
 }

src/display_list.rs

@@ -31,7 +31,7 @@
 //! assert_eq!(DisplayList::from(snippet).body, vec![
 //!     DisplayLine::Description {
 //!         snippet_type: DisplaySnippetType::Error,
-//!         id: "E0061".to_string(),
+//!         id: Some("E0061".to_string()),
 //!         label: "this function takes 1 parameter but 0 parameters were supplied".to_string(),
 //!     },
 //!     DisplayLine::Origin {
@@ -71,7 +71,7 @@ pub struct DisplayList {
 pub enum DisplayLine {
     Description {
         snippet_type: DisplaySnippetType,
-        id: String,
+        id: Option<String>,
         label: String,
     },
     Origin {
@@ -123,11 +123,10 @@ fn format_header(snippet: &Snippet, body: &[DisplayLine]) -> Vec<DisplayLine> {
     let mut header = vec![];
 
     if let Some(ref annotation) = snippet.title {
-        let id = annotation.id.clone().unwrap_or("".to_string());
         let label = annotation.label.clone().unwrap_or("".to_string());
         header.push(DisplayLine::Description {
             snippet_type: DisplaySnippetType::from(annotation.annotation_type),
-            id,
+            id: annotation.id.clone(),
             label,
         })
     }
@@ -234,7 +233,7 @@ fn format_body(snippet: &Snippet) -> Vec<DisplayLine> {
             let body_idx = idx + annotation_line_count;
             match annotation.range {
                 (start, _) if start > line_end => false,
-                (start, end) if start >= line_start && end <= line_end => {
+                (start, end) if start >= line_start && end <= line_end + 1 => {
                     let range = (start - line_start, end - line_start);
                     body.insert(
                         body_idx + 1,

src/format.rs

@@ -71,7 +71,7 @@ impl DisplayListFormatting for Formatter {
         match dl {
             DisplayLine::Description {
                 snippet_type,
-                id,
+                id: Some(id),
                 label,
             } => writeln!(
                 f,
@@ -80,6 +80,11 @@ impl DisplayListFormatting for Formatter {
                 id,
                 label
             ),
+            DisplayLine::Description {
+                snippet_type,
+                id: None,
+                label,
+            } => writeln!(f, "{}: {}", Self::format_snippet_type(&snippet_type), label),
             DisplayLine::Origin { path, row, col } => writeln!(
                 f,
                 "{}--> {}:{}:{}",

src/format_color.rs

@@ -1,6 +1,7 @@
 extern crate ansi_term;
 
-use self::ansi_term::Color::{Fixed, White};
+use self::ansi_term::Color::Fixed;
+use self::ansi_term::Style;
 use display_list::{DisplayAnnotationType, DisplayLine, DisplayList, DisplayMark,
                    DisplaySnippetType};
 use display_list_formatting::DisplayListFormatting;
@@ -74,21 +75,38 @@ impl DisplayListFormatting for Formatter {
         match dl {
             DisplayLine::Description {
                 snippet_type,
-                id,
+                id: Some(id),
                 label,
             } => {
                 let color = match snippet_type {
                     DisplaySnippetType::Error => Fixed(9),
                     DisplaySnippetType::Warning => Fixed(11),
                 };
-                writeln!(f,
+                writeln!(
+                    f,
                     "{}{}",
                     color.bold().paint(format!(
                         "{}[{}]",
                         Self::format_snippet_type(&snippet_type),
                         id
                     )),
-                    White.bold().paint(format!(": {}", label))
+                    Style::new().bold().paint(format!(": {}", label))
+                )
+            }
+            DisplayLine::Description {
+                snippet_type,
+                id: None,
+                label,
+            } => {
+                let color = match snippet_type {
+                    DisplaySnippetType::Error => Fixed(9),
+                    DisplaySnippetType::Warning => Fixed(11),
+                };
+                writeln!(
+                    f,
+                    "{}{}",
+                    color.bold().paint(Self::format_snippet_type(&snippet_type)),
+                    Style::new().bold().paint(format!(": {}", label))
                 )
             }
             DisplayLine::Origin { path, row, col } => writeln!(
@@ -118,7 +136,7 @@ impl DisplayListFormatting for Formatter {
                     Self::format_inline_marks(&inline_marks, inline_marks_width),
                     content,
                 )
-            },
+            }
             DisplayLine::Annotation {
                 inline_marks,
                 range,

src/lib.rs

@@ -27,8 +27,8 @@
 
 pub mod display_list;
 pub mod display_list_formatting;
-#[cfg(feature = "ansi_term")]
-pub mod format_color;
 #[cfg(not(feature = "ansi_term"))]
 pub mod format;
+#[cfg(feature = "ansi_term")]
+pub mod format_color;
 pub mod snippet;

tests/fixtures.rs

@@ -35,7 +35,7 @@ fn read_fixture<P: AsRef<Path>>(path: P) -> Result<Snippet, Box<Error>> {
 
 #[test]
 fn test_fixtures() {
-    for entry in glob("./tests/fixtures/**/*.yaml").expect("Failed to read glob pattern") {
+    for entry in glob("./tests/fixtures/no-color/**/*.yaml").expect("Failed to read glob pattern") {
         let p = entry.expect("Error while getting an entry");
         let path_in = p.to_str().expect("Can't print path");