refactor: remove --json format for tracing

HerringtonDarkholme · HerringtonDarkholme · commit ed05be47aa14 · 2024-11-04T11:39:11.000-05:00
BREAKING CHANGE: remove json format for tracing
diff --git a/crates/cli/src/run.rs b/crates/cli/src/run.rs
@@ -190,7 +190,7 @@ impl<P: Printer> Worker for RunWithInferredLang<P> {
     }
     printer.after_print()?;
     // TODO: better handle output format
-    if let Some(trace) = self.trace.print(self.arg.output.json.is_some()) {
+    if let Some(trace) = self.trace.print() {
       eprintln!("{}", trace);
     }
     Ok(())
@@ -267,7 +267,7 @@ impl<P: Printer> Worker for RunWithSpecificLang<P> {
       has_matches = true;
     }
     printer.after_print()?;
-    if let Some(stats) = self.stats.print(self.arg.output.json.is_some()) {
+    if let Some(stats) = self.stats.print() {
       eprintln!("{}", stats);
     }
     if !has_matches && self.pattern.has_error() {
diff --git a/crates/cli/src/scan.rs b/crates/cli/src/scan.rs
@@ -177,7 +177,7 @@ impl<P: Printer> Worker for ScanWithConfig<P> {
       )?;
     }
     self.printer.after_print()?;
-    if let Some(trace) = self.trace.print(self.arg.output.json.is_some()) {
+    if let Some(trace) = self.trace.print() {
       eprintln!("{}", trace);
     }
     if error_count > 0 {
diff --git a/crates/cli/src/utils/tracing.rs b/crates/cli/src/utils/tracing.rs
@@ -86,18 +86,13 @@ pub struct TraceInfo<T> {
   #[serde(flatten)]
   pub inner: T,
 }
+
 impl TraceInfo<()> {
   // TODO: support more format?
-  pub fn print(&self, is_json: bool) -> Option<String> {
+  pub fn print(&self) -> Option<String> {
     match self.level {
       Tracing::Nothing => None,
-      Tracing::Summary | Tracing::Entity => {
-        if is_json {
-          Some(serde_json::to_string(self).ok()?)
-        } else {
-          Some(self.file_trace.print())
-        }
-      }
+      Tracing::Summary | Tracing::Entity => Some(self.file_trace.print()),
     }
   }
 
@@ -112,20 +107,14 @@ impl TraceInfo<()> {
 
 impl TraceInfo<RuleTrace> {
   // TODO: support more format?
-  pub fn print(&self, is_json: bool) -> Option<String> {
+  pub fn print(&self) -> Option<String> {
     match self.level {
       Tracing::Nothing => None,
-      Tracing::Summary | Tracing::Entity => {
-        if is_json {
-          Some(serde_json::to_string(self).ok()?)
-        } else {
-          Some(format!(
-            "{}\n{}",
-            self.file_trace.print(),
-            self.inner.print()
-          ))
-        }
-      }
+      Tracing::Summary | Tracing::Entity => Some(format!(
+        "{}\n{}",
+        self.file_trace.print(),
+        self.inner.print()
+      )),
     }
   }
   pub fn print_file(
@@ -181,7 +170,7 @@ mod test {
       run_trace.file_trace.files_skipped.load(Ordering::Relaxed),
       0
     );
-    let printed = run_trace.print(false).expect("should have output");
+    let printed = run_trace.print().expect("should have output");
     assert_eq!(printed, "Files scanned: 0, Files skipped: 0");
 
     let rule_stats = RuleTrace {
@@ -200,7 +189,7 @@ mod test {
     );
     assert_eq!(scan_trace.inner.effective_rule_count, 10);
     assert_eq!(scan_trace.inner.skipped_rule_count, 2);
-    let printed = scan_trace.print(false).expect("should have output");
+    let printed = scan_trace.print().expect("should have output");
     assert_eq!(
       printed,
       "Files scanned: 0, Files skipped: 0\nEffective rules: 10, Skipped rules: 2"
@@ -212,7 +201,7 @@ mod test {
     let tracing = Tracing::Nothing;
     let run_trace = tracing.run_trace();
     assert_eq!(run_trace.level, Tracing::Nothing);
-    let printed = run_trace.print(false);
+    let printed = run_trace.print();
     assert!(printed.is_none());
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ impl<P: Printer> Worker for RunWithInferredLang<P> {`
`190`	`190`	`}`
`191`	`191`	`printer.after_print()?;`
`192`	`192`	`// TODO: better handle output format`
`193`		`- if let Some(trace) = self.trace.print(self.arg.output.json.is_some()) {`
	`193`	`+ if let Some(trace) = self.trace.print() {`
`194`	`194`	`eprintln!("{}", trace);`
`195`	`195`	`}`
`196`	`196`	`Ok(())`
`@@ -267,7 +267,7 @@ impl<P: Printer> Worker for RunWithSpecificLang<P> {`
`267`	`267`	`has_matches = true;`
`268`	`268`	`}`
`269`	`269`	`printer.after_print()?;`
`270`		`- if let Some(stats) = self.stats.print(self.arg.output.json.is_some()) {`
	`270`	`+ if let Some(stats) = self.stats.print() {`
`271`	`271`	`eprintln!("{}", stats);`
`272`	`272`	`}`
`273`	`273`	`if !has_matches && self.pattern.has_error() {`
Original file line number	Diff line number	Diff line change
`@@ -177,7 +177,7 @@ impl<P: Printer> Worker for ScanWithConfig<P> {`
`177`	`177`	`)?;`
`178`	`178`	`}`
`179`	`179`	`self.printer.after_print()?;`
`180`		`- if let Some(trace) = self.trace.print(self.arg.output.json.is_some()) {`
	`180`	`+ if let Some(trace) = self.trace.print() {`
`181`	`181`	`eprintln!("{}", trace);`
`182`	`182`	`}`
`183`	`183`	`if error_count > 0 {`