refactor: Move diagnostic printing to Shell

rust-lang · Apr 30, 2024 · 5415b04 · 5415b04
1 parent ba6fb40
commit 5415b04
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 30 deletions.
diff --git a/src/cargo/core/shell.rs b/src/cargo/core/shell.rs
@@ -2,6 +2,7 @@ use std::fmt;
 use std::io::prelude::*;
 use std::io::IsTerminal;
 
+use annotate_snippets::{Message, Renderer};
 use anstream::AutoStream;
 use anstyle::Style;
 
@@ -391,6 +392,19 @@ impl Shell {
         drop(writeln!(self.out(), "{}", encoded));
         Ok(())
     }
+
+    /// Prints the passed in [Message] to stderr
+    pub fn print_message(&mut self, message: Message<'_>) -> std::io::Result<()> {
+        let term_width = self
+            .err_width()
+            .diagnostic_terminal_width()
+            .unwrap_or(annotate_snippets::renderer::DEFAULT_TERM_WIDTH);
+        writeln!(
+            self.err(),
+            "{}",
+            Renderer::styled().term_width(term_width).render(message)
+        )
+    }
 }
 
 impl Default for Shell {

diff --git a/src/cargo/util/lints.rs b/src/cargo/util/lints.rs
@@ -3,7 +3,7 @@ use crate::core::FeatureValue::Dep;
 use crate::core::{Edition, FeatureValue, Package};
 use crate::util::interning::InternedString;
 use crate::{CargoResult, GlobalContext};
-use annotate_snippets::{Level, Renderer, Snippet};
+use annotate_snippets::{Level, Snippet};
 use cargo_util_schemas::manifest::{TomlLintLevel, TomlToolLints};
 use pathdiff::diff_paths;
 use std::collections::HashSet;
@@ -270,13 +270,8 @@ pub fn check_im_a_teapot(
                     .fold(true),
             )
             .footer(Level::Note.title(&emitted_reason));
-        let renderer = Renderer::styled().term_width(
-            gctx.shell()
-                .err_width()
-                .diagnostic_terminal_width()
-                .unwrap_or(annotate_snippets::renderer::DEFAULT_TERM_WIDTH),
-        );
-        writeln!(gctx.shell().err(), "{}", renderer.render(message))?;
+
+        gctx.shell().print_message(message)?;
     }
     Ok(())
 }
@@ -367,13 +362,7 @@ pub fn check_implicit_features(
             ));
             message = message.footer(Level::Note.title(emitted_source.as_ref().unwrap()));
         }
-        let renderer = Renderer::styled().term_width(
-            gctx.shell()
-                .err_width()
-                .diagnostic_terminal_width()
-                .unwrap_or(annotate_snippets::renderer::DEFAULT_TERM_WIDTH),
-        );
-        writeln!(gctx.shell().err(), "{}", renderer.render(message))?;
+        gctx.shell().print_message(message)?;
     }
     Ok(())
 }
@@ -476,13 +465,8 @@ pub fn unused_dependencies(
                         "remove the dependency or activate it in a feature with `dep:{name}`"
                     );
                     message = message.footer(Level::Help.title(&help));
-                    let renderer = Renderer::styled().term_width(
-                        gctx.shell()
-                            .err_width()
-                            .diagnostic_terminal_width()
-                            .unwrap_or(annotate_snippets::renderer::DEFAULT_TERM_WIDTH),
-                    );
-                    writeln!(gctx.shell().err(), "{}", renderer.render(message))?;
+
+                    gctx.shell().print_message(message)?;
                 }
             }
         }

diff --git a/src/cargo/util/toml/mod.rs b/src/cargo/util/toml/mod.rs
@@ -1,4 +1,4 @@
-use annotate_snippets::{Level, Renderer, Snippet};
+use annotate_snippets::{Level, Snippet};
 use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
 use std::ffi::OsStr;
 use std::path::{Path, PathBuf};
@@ -2343,13 +2343,7 @@ fn emit_diagnostic(
             .fold(true)
             .annotation(Level::Error.span(span)),
     );
-    let renderer = Renderer::styled().term_width(
-        gctx.shell()
-            .err_width()
-            .diagnostic_terminal_width()
-            .unwrap_or(annotate_snippets::renderer::DEFAULT_TERM_WIDTH),
-    );
-    if let Err(err) = writeln!(gctx.shell().err(), "{}", renderer.render(message)) {
+    if let Err(err) = gctx.shell().print_message(message) {
         return err.into();
     }
     return AlreadyPrintedError::new(e.into()).into();