Merge pull request #1099 from micahscopes/no-print

Don't print to stdio/stderr; use tracing

Author: micahscopes

Cargo.lock

@@ -79,7 +79,7 @@ coverage:
 
 .PHONY: clippy
 clippy:
-	cargo clippy --workspace --all-targets --all-features -- -D warnings -A clippy::upper-case-acronyms -A clippy::large-enum-variant
+	cargo clippy --workspace --all-targets --all-features -- -D warnings -A clippy::upper-case-acronyms -A clippy::large-enum-variant -W clippy::print_stdout -W clippy::print_stderr
 
 .PHONY: rustfmt
 rustfmt:

Makefile

@@ -14,6 +14,7 @@ parser.workspace = true
 common.workspace = true
 camino.workspace = true
 url.workspace = true
+tracing.workspace = true
 
 [[bench]]
 name = "analysis"

crates/bench/Cargo.toml

@@ -1,3 +1,5 @@
+use tracing::error;
+
 fn main() {
-    eprintln!("run `cargo bench`");
+    error!("run `cargo bench`");
 }

crates/bench/src/main.rs

@@ -21,3 +21,4 @@ resolver.workspace = true
 url.workspace = true
 smol_str.workspace = true
 test-utils.workspace = true
+tracing.workspace = true

crates/driver/Cargo.toml

@@ -71,7 +71,9 @@ impl DiagnosticsCollection<'_> {
             term::emit(&mut buffer, &config, &CsDbWrapper(db), &diag.to_cs(db)).unwrap();
         }
 
-        eprintln!("{}", std::str::from_utf8(buffer.as_slice()).unwrap());
+        writer
+            .print(&buffer)
+            .expect("Failed to write diagnostics to stderr");
     }
 
     /// Format the accumulated diagnostics to a string.

crates/driver/src/db.rs

@@ -14,11 +14,12 @@ use resolver::{
     ingot::{source_files::SourceFiles, Ingot, IngotResolver},
     Resolver,
 };
+use tracing::error;
 use url::Url;
 
 pub fn run(opts: &Options) {
     match &opts.command {
-        Command::Build => eprintln!("`fe build` doesn't work at the moment"),
+        Command::Build => error!("`fe build` doesn't work at the moment"),
         Command::Check { path, core } => {
             let mut db = DriverDataBase::default();
             let mut ingot_resolver = IngotResolver::default();
@@ -36,9 +37,9 @@ pub fn run(opts: &Options) {
                         let core_base_url = Url::parse("core-ingot:///").unwrap();
                         let diagnostics = ingot_resolver.take_diagnostics();
                         if !diagnostics.is_empty() {
-                            eprintln!("an error was encountered while resolving `{core_path}`");
+                            error!("an error was encountered while resolving `{core_path}`");
                             for diagnostic in diagnostics {
-                                eprintln!("{diagnostic}")
+                                error!("{diagnostic}")
                             }
                             std::process::exit(2)
                         }
@@ -61,19 +62,19 @@ pub fn run(opts: &Options) {
                         core_base_url
                     }
                     Ok(Ingot::SingleFile { .. }) => {
-                        eprintln!("standalone core ingot not supported");
+                        error!("standalone core ingot not supported");
                         std::process::exit(2)
                     }
                     Ok(_) => {
-                        eprintln!("an error was encountered while resolving `{core_path}`");
+                        error!("an error was encountered while resolving `{core_path}`");
                         for diagnostic in ingot_resolver.take_diagnostics() {
-                            eprintln!("{diagnostic}")
+                            error!("{diagnostic}")
                         }
                         std::process::exit(2)
                     }
                     Err(error) => {
-                        eprintln!("an error was encountered while resolving `{core_path}`");
-                        eprintln!("{error}");
+                        error!("an error was encountered while resolving `{core_path}`");
+                        error!("{error}");
                         std::process::exit(2)
                     }
                 }
@@ -95,9 +96,9 @@ pub fn run(opts: &Options) {
 
                     let diagnostics = ingot_resolver.take_diagnostics();
                     if !diagnostics.is_empty() {
-                        eprintln!("an error was encountered while resolving `{path}`");
+                        error!("an error was encountered while resolving `{path}`");
                         for diagnostic in diagnostics {
-                            eprintln!("{diagnostic}")
+                            error!("{diagnostic}")
                         }
                         std::process::exit(2)
                     }
@@ -124,12 +125,12 @@ pub fn run(opts: &Options) {
                 }
                 Ok(_) => {
                     for diagnostic in ingot_resolver.take_diagnostics() {
-                        eprintln!("{diagnostic}")
+                        error!("{diagnostic}")
                     }
                     std::process::exit(2)
                 }
                 Err(error) => {
-                    eprintln!("{error}: {path}");
+                    error!("{error}: {path}");
                     std::process::exit(2)
                 }
             };
@@ -144,7 +145,7 @@ pub fn run(opts: &Options) {
                 std::process::exit(1);
             }
         }
-        Command::New => eprintln!("`fe new` doesn't work at the moment"),
+        Command::New => error!("`fe new` doesn't work at the moment"),
     }
 }
 

crates/driver/src/lib.rs

@@ -6,3 +6,5 @@ edition = "2021"
 [dependencies]
 clap.workspace = true
 driver.workspace = true
+tracing.workspace = true
+tracing-subscriber.workspace = true

crates/fe/Cargo.toml

@@ -3,5 +3,14 @@ use driver::Options;
 
 fn main() {
     let opts = Options::parse();
+
+    // Initialize tracing with ERROR as default level
+    tracing_subscriber::fmt()
+        .with_env_filter(
+            tracing_subscriber::EnvFilter::try_from_default_env()
+                .unwrap_or_else(|_| tracing_subscriber::EnvFilter::new("error")),
+        )
+        .init();
+
     driver::run(&opts);
 }

crates/fe/src/main.rs

@@ -30,6 +30,7 @@ use hir::{
 };
 use rustc_hash::FxHashMap;
 use test_utils::url_utils::UrlExt;
+use tracing::error;
 use url::Url;
 
 type CodeSpanFileId = usize;
@@ -81,7 +82,7 @@ impl HirAnalysisTestDb {
                 let cs_diag = &diag.to_cs(self);
                 term::emit(&mut buffer, &config, &CsDbWrapper(self), cs_diag).unwrap();
             }
-            eprintln!("{}", std::str::from_utf8(buffer.as_slice()).unwrap());
+            error!("{}", std::str::from_utf8(buffer.as_slice()).unwrap());
 
             panic!("this module contains errors");
         }