Finish formatter linting

Author: Zibi Braniecki

examples/expected_type.rs

@@ -39,5 +39,5 @@ fn main() {
 
     let dl = DisplayList::from(snippet);
     let dlf = DisplayListFormatter::new(true);
-    println!("{}", dlf.format(dl));
+    println!("{}", dlf.format(&dl));
 }

examples/footer.rs

@@ -38,5 +38,5 @@ fn main() {
 
     let dl = DisplayList::from(snippet);
     let dlf = DisplayListFormatter::new(true);
-    println!("{}", dlf.format(dl));
+    println!("{}", dlf.format(&dl));
 }

examples/format.rs

@@ -57,5 +57,5 @@ fn main() {
 
     let dl = DisplayList::from(snippet);
     let dlf = DisplayListFormatter::new(true);
-    println!("{}", dlf.format(dl));
+    println!("{}", dlf.format(&dl));
 }

examples/multislice.rs

@@ -32,5 +32,5 @@ fn main() {
 
     let dl = DisplayList::from(snippet);
     let dlf = DisplayListFormatter::new(true);
-    println!("{}", dlf.format(dl));
+    println!("{}", dlf.format(&dl));
 }

src/formatter/mod.rs

@@ -45,13 +45,16 @@ fn repeat_char(c: char, n: usize) -> String {
 ///         }
 ///     ]
 /// };
-/// assert_eq!(dlf.format(dl), "192 | Example line of text");
+/// assert_eq!(dlf.format(&dl), "192 | Example line of text");
 /// ```
 pub struct DisplayListFormatter {
     stylesheet: Box<Stylesheet>,
 }
 
 impl DisplayListFormatter {
+    /// Constructor for the struct. The argument `color` selects
+    /// the stylesheet depending on the user preferences and `ansi_term`
+    /// crate availability.
     pub fn new(color: bool) -> Self {
         if color {
             Self {
@@ -67,7 +70,8 @@ impl DisplayListFormatter {
         }
     }
 
-    pub fn format(&self, dl: DisplayList) -> String {
+    /// Formats a `DisplayList` into a String.
+    pub fn format(&self, dl: &DisplayList) -> String {
         let lineno_width = dl.body.iter().fold(0, |max, line| match line {
             DisplayLine::Source {
                 lineno: Some(lineno),
@@ -166,11 +170,7 @@ impl DisplayListFormatter {
                 label_part
             )
         } else if !formatted_type.is_empty() {
-            format!(
-                "{}{}",
-                color.paint(format!("{}", formatted_type)),
-                label_part
-            )
+            format!("{}{}", color.paint(formatted_type), label_part)
         } else {
             label
         }
@@ -290,10 +290,7 @@ impl DisplayListFormatter {
                         )
                     }
                 } else {
-                    format!(
-                        "{}",
-                        self.format_annotation(annotation, *continuation, false)
-                    )
+                    self.format_annotation(annotation, *continuation, false)
                 }
             }
         }
@@ -329,7 +326,7 @@ impl DisplayListFormatter {
                         if !marks.trim().is_empty() {
                             prefix.push_str(&format!(" {}", marks));
                         }
-                        format!("{}", prefix)
+                        prefix
                     }
                 }
             }
@@ -370,7 +367,7 @@ impl DisplayListFormatter {
                         DisplayAnnotationType::None => StyleClass::None,
                     };
                     let color = self.stylesheet.get_style(style);
-                    format!("{}", color.paint(String::from(sigil)))
+                    color.paint(String::from(sigil))
                 })
                 .collect::<Vec<String>>()
                 .join(""),

tests/fixtures.rs

@@ -47,7 +47,7 @@ fn test_fixtures() {
 
         let dl = DisplayList::from(snippet);
         let dlf = DisplayListFormatter::new(true);
-        let actual_out = dlf.format(dl);
+        let actual_out = dlf.format(&dl);
         println!("{}", expected_out);
         println!("{}", actual_out.trim_right());
 

tests/formatter.rs

@@ -15,7 +15,7 @@ fn test_source_empty() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), " |");
+    assert_eq!(dlf.format(&dl), " |");
 }
 
 #[test]
@@ -42,7 +42,7 @@ fn test_source_content() {
     let dlf = DisplayListFormatter::new(false);
 
     assert_eq!(
-        dlf.format(dl),
+        dlf.format(&dl),
         "56 | This is an example\n57 | of content lines"
     );
 }
@@ -73,7 +73,7 @@ fn test_source_annotation_standalone_singleline() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), " | ^^^^^ Example string");
+    assert_eq!(dlf.format(&dl), " | ^^^^^ Example string");
 }
 
 #[test]
@@ -122,7 +122,7 @@ fn test_source_annotation_standalone_multiline() {
     let dlf = DisplayListFormatter::new(false);
 
     assert_eq!(
-        dlf.format(dl),
+        dlf.format(&dl),
         " | ----- help: Example string\n |             Second line"
     );
 }
@@ -267,7 +267,7 @@ fn test_source_annotation_standalone_multi_annotation() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), " | ----- info: Example string\n |             Second line\n |       warning: This is a note\n |                Second line of the warning\n | ----- info: This is an info\n | ----- help: This is help\n |  This is an annotation of type none");
+    assert_eq!(dlf.format(&dl), " | ----- info: Example string\n |             Second line\n |       warning: This is a note\n |                Second line of the warning\n | ----- info: This is an info\n | ----- help: This is help\n |  This is an annotation of type none");
 }
 
 #[test]
@@ -297,7 +297,7 @@ fn test_fold_line() {
     let dlf = DisplayListFormatter::new(false);
 
     assert_eq!(
-        dlf.format(dl),
+        dlf.format(&dl),
         "    5 | This is line 5\n...\n10021 | ... and now we're at line 10021"
     );
 }
@@ -314,7 +314,7 @@ fn test_raw_origin_initial_nopos() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), "--> src/test.rs");
+    assert_eq!(dlf.format(&dl), "--> src/test.rs");
 }
 
 #[test]
@@ -329,7 +329,7 @@ fn test_raw_origin_initial_pos() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), "--> src/test.rs:23:15");
+    assert_eq!(dlf.format(&dl), "--> src/test.rs:23:15");
 }
 
 #[test]
@@ -344,7 +344,7 @@ fn test_raw_origin_continuation() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), "::: src/test.rs:23:15");
+    assert_eq!(dlf.format(&dl), "::: src/test.rs:23:15");
 }
 
 #[test]
@@ -368,7 +368,7 @@ fn test_raw_annotation_unaligned() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), "error[E0001]: This is an error");
+    assert_eq!(dlf.format(&dl), "error[E0001]: This is an error");
 }
 
 #[test]
@@ -407,7 +407,7 @@ fn test_raw_annotation_unaligned_multiline() {
     let dlf = DisplayListFormatter::new(false);
 
     assert_eq!(
-        dlf.format(dl),
+        dlf.format(&dl),
         "warning[E0001]: This is an error\n                Second line of the error"
     );
 }
@@ -433,7 +433,7 @@ fn test_raw_annotation_aligned() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), " = error[E0001]: This is an error");
+    assert_eq!(dlf.format(&dl), " = error[E0001]: This is an error");
 }
 
 #[test]
@@ -472,7 +472,7 @@ fn test_raw_annotation_aligned_multiline() {
     let dlf = DisplayListFormatter::new(false);
 
     assert_eq!(
-        dlf.format(dl),
+        dlf.format(&dl),
         " = warning[E0001]: This is an error\n                   Second line of the error"
     );
 }
@@ -527,7 +527,7 @@ fn test_different_annotation_types() {
     let dlf = DisplayListFormatter::new(false);
 
     assert_eq!(
-        dlf.format(dl),
+        dlf.format(&dl),
         "note: This is a note\nThis is just a string\n  Second line of none type annotation",
     );
 }
@@ -549,5 +549,5 @@ fn test_inline_marks_empty_line() {
 
     let dlf = DisplayListFormatter::new(false);
 
-    assert_eq!(dlf.format(dl), " | |",);
+    assert_eq!(dlf.format(&dl), " | |",);
 }