feat(cli): multi reporters

Author: Netail

.changeset/slimy-files-feel.md

@@ -0,0 +1,5 @@
+---
+"@biomejs/biome": patch
+---
+
+Support multiple `--reporter` options

crates/biome_cli/src/cli_options.rs

@@ -57,9 +57,10 @@ pub struct CliOptions {
     #[bpaf(
         long("reporter"),
         argument("json|json-pretty|github|junit|summary|gitlab|checkstyle|rdjson"),
-        fallback(CliReporter::default())
+        fallback(CliReporter::default()),
+        many
     )]
-    pub reporter: CliReporter,
+    pub reporter: Vec<CliReporter>,
 
     /// Optional path to redirect log messages to.
     ///

crates/biome_cli/src/execute/mod.rs

@@ -41,7 +41,7 @@ use tracing::{info, instrument};
 #[derive(Debug, Clone)]
 pub struct Execution {
     /// How the information should be collected and reported
-    report_mode: ReportMode,
+    report_mode: Vec<ReportMode>,
 
     /// The modality of execution of the traversal
     traversal_mode: TraversalMode,
@@ -283,7 +283,7 @@ impl From<CliReporter> for ReportMode {
 impl Execution {
     pub(crate) fn new(mode: TraversalMode) -> Self {
         Self {
-            report_mode: ReportMode::default(),
+            report_mode: Vec::from([ReportMode::default()]),
             traversal_mode: mode,
             max_diagnostics: 20,
         }
@@ -300,7 +300,7 @@ impl Execution {
             .is_some_and(|value| value == "true");
 
         Self {
-            report_mode: ReportMode::default(),
+            report_mode: Vec::from([ReportMode::default()]),
             traversal_mode: TraversalMode::CI {
                 environment: if is_github {
                     Some(ExecutionEnvironment::GitHub)
@@ -317,7 +317,11 @@ impl Execution {
 
     /// It sets the reporting mode by reading the [CliOptions]
     pub(crate) fn set_report(mut self, cli_options: &CliOptions) -> Self {
-        self.report_mode = cli_options.reporter.clone().into();
+        self.report_mode = cli_options
+            .reporter
+            .iter()
+            .map(|reporter| reporter.clone().into())
+            .collect::<Vec<ReportMode>>();
         self
     }
 
@@ -455,12 +459,12 @@ impl Execution {
                 stdin: None,
                 vcs_targeted,
             },
-            report_mode: ReportMode::default(),
+            report_mode: Vec::from([ReportMode::default()]),
             max_diagnostics: 0,
         }
     }
 
-    pub fn report_mode(&self) -> &ReportMode {
+    pub fn report_mode(&self) -> &Vec<ReportMode> {
         &self.report_mode
     }
     pub(crate) fn to_feature(&self) -> FeatureName {
@@ -532,12 +536,15 @@ pub fn execute_mode(
     project_key: ProjectKey,
 ) -> Result<(), CliDiagnostic> {
     // If a custom reporter was provided, let's lift the limit so users can see all of them
-    execution.max_diagnostics = if cli_options.reporter.is_default() {
+    execution.max_diagnostics = if cli_options
+        .reporter
+        .iter()
+        .any(|reporter| reporter.is_default())
+    {
         cli_options.max_diagnostics.into()
     } else {
         info!(
-            "Removing the limit of --max-diagnostics, because of a reporter different from the default one: {}",
-            cli_options.reporter
+            "Removing the limit of --max-diagnostics, because reporter(s) does not include the default one"
         );
         u32::MAX
     };
@@ -612,124 +619,127 @@ pub fn execute_mode(
         max_diagnostics: cli_options.max_diagnostics,
     };
 
-    match execution.report_mode {
-        ReportMode::Terminal { with_summary } => {
-            if with_summary {
-                let reporter = SummaryReporter {
+    for report_mode in execution.report_mode {
+        match report_mode {
+            ReportMode::Terminal { with_summary } => {
+                if with_summary {
+                    let reporter = SummaryReporter {
+                        summary,
+                        diagnostics_payload,
+                        execution: execution.clone(),
+                        verbose: cli_options.verbose,
+                        working_directory: fs.working_directory().clone(),
+                        evaluated_paths: evaluated_paths.clone(),
+                    };
+                    reporter.write(&mut SummaryReporterVisitor(console))?;
+                } else {
+                    let reporter = ConsoleReporter {
+                        summary,
+                        diagnostics_payload,
+                        execution: execution.clone(),
+                        evaluated_paths: evaluated_paths.clone(),
+                        verbose: cli_options.verbose,
+                        working_directory: fs.working_directory().clone(),
+                    };
+                    reporter.write(&mut ConsoleReporterVisitor(console))?;
+                }
+            }
+            ReportMode::Json { pretty } => {
+                console.error(markup! {
+                        <Warn>"The "<Emphasis>"--json"</Emphasis>" option is "<Underline>"unstable/experimental"</Underline>" and its output might change between patches/minor releases."</Warn>
+                    });
+                let reporter = JsonReporter {
                     summary,
+                    diagnostics: diagnostics_payload,
+                    execution: execution.clone(),
+                    verbose: cli_options.verbose,
+                    working_directory: fs.working_directory().clone(),
+                };
+                let mut buffer = JsonReporterVisitor::new(summary);
+                reporter.write(&mut buffer)?;
+                if pretty {
+                    let content = serde_json::to_string(&buffer).map_err(|error| {
+                        CliDiagnostic::Report(ReportDiagnostic::Serialization(
+                            SerdeJsonError::from(error),
+                        ))
+                    })?;
+                    let report_file = BiomePath::new(TEMPORARY_INTERNAL_REPORTER_FILE);
+                    session.app.workspace.open_file(OpenFileParams {
+                        project_key,
+                        content: FileContent::from_client(content),
+                        path: report_file.clone(),
+                        document_file_source: None,
+                        persist_node_cache: false,
+                    })?;
+                    let code = session.app.workspace.format_file(FormatFileParams {
+                        project_key,
+                        path: report_file.clone(),
+                    })?;
+                    console.log(markup! {
+                        {code.as_code()}
+                    });
+                    session.app.workspace.close_file(CloseFileParams {
+                        project_key,
+                        path: report_file,
+                    })?;
+                } else {
+                    console.log(markup! {
+                        {buffer}
+                    });
+                }
+            }
+            ReportMode::GitHub => {
+                let reporter = GithubReporter {
                     diagnostics_payload,
                     execution: execution.clone(),
                     verbose: cli_options.verbose,
                     working_directory: fs.working_directory().clone(),
-                    evaluated_paths,
                 };
-                reporter.write(&mut SummaryReporterVisitor(console))?;
-            } else {
-                let reporter = ConsoleReporter {
+                reporter.write(&mut GithubReporterVisitor(console))?;
+            }
+            ReportMode::GitLab => {
+                let reporter = GitLabReporter {
+                    diagnostics: diagnostics_payload,
+                    execution: execution.clone(),
+                    verbose: cli_options.verbose,
+                    working_directory: fs.working_directory().clone(),
+                };
+                reporter.write(&mut GitLabReporterVisitor::new(
+                    console,
+                    session.app.workspace.fs().working_directory(),
+                ))?;
+            }
+            ReportMode::Junit => {
+                let reporter = JunitReporter {
                     summary,
                     diagnostics_payload,
                     execution: execution.clone(),
-                    evaluated_paths,
                     verbose: cli_options.verbose,
                     working_directory: fs.working_directory().clone(),
                 };
-                reporter.write(&mut ConsoleReporterVisitor(console))?;
+                reporter.write(&mut JunitReporterVisitor::new(console))?;
             }
-        }
-        ReportMode::Json { pretty } => {
-            console.error(markup! {
-                    <Warn>"The "<Emphasis>"--json"</Emphasis>" option is "<Underline>"unstable/experimental"</Underline>" and its output might change between patches/minor releases."</Warn>
-                });
-            let reporter = JsonReporter {
-                summary,
-                diagnostics: diagnostics_payload,
-                execution: execution.clone(),
-                verbose: cli_options.verbose,
-                working_directory: fs.working_directory().clone(),
-            };
-            let mut buffer = JsonReporterVisitor::new(summary);
-            reporter.write(&mut buffer)?;
-            if pretty {
-                let content = serde_json::to_string(&buffer).map_err(|error| {
-                    CliDiagnostic::Report(ReportDiagnostic::Serialization(SerdeJsonError::from(
-                        error,
-                    )))
-                })?;
-                let report_file = BiomePath::new(TEMPORARY_INTERNAL_REPORTER_FILE);
-                session.app.workspace.open_file(OpenFileParams {
-                    project_key,
-                    content: FileContent::from_client(content),
-                    path: report_file.clone(),
-                    document_file_source: None,
-                    persist_node_cache: false,
-                })?;
-                let code = session.app.workspace.format_file(FormatFileParams {
-                    project_key,
-                    path: report_file.clone(),
-                })?;
-                console.log(markup! {
-                    {code.as_code()}
-                });
-                session.app.workspace.close_file(CloseFileParams {
-                    project_key,
-                    path: report_file,
-                })?;
-            } else {
-                console.log(markup! {
-                    {buffer}
-                });
+            ReportMode::Checkstyle => {
+                let reporter = CheckstyleReporter {
+                    summary,
+                    diagnostics_payload,
+                    execution: execution.clone(),
+                    verbose: cli_options.verbose,
+                    working_directory: fs.working_directory().clone(),
+                };
+                reporter.write(
+                    &mut crate::reporter::checkstyle::CheckstyleReporterVisitor::new(console),
+                )?;
+            }
+            ReportMode::RdJson => {
+                let reporter = RdJsonReporter {
+                    diagnostics_payload,
+                    execution: execution.clone(),
+                    verbose: cli_options.verbose,
+                    working_directory: fs.working_directory().clone(),
+                };
+                reporter.write(&mut RdJsonReporterVisitor(console))?;
             }
-        }
-        ReportMode::GitHub => {
-            let reporter = GithubReporter {
-                diagnostics_payload,
-                execution: execution.clone(),
-                verbose: cli_options.verbose,
-                working_directory: fs.working_directory().clone(),
-            };
-            reporter.write(&mut GithubReporterVisitor(console))?;
-        }
-        ReportMode::GitLab => {
-            let reporter = GitLabReporter {
-                diagnostics: diagnostics_payload,
-                execution: execution.clone(),
-                verbose: cli_options.verbose,
-                working_directory: fs.working_directory().clone(),
-            };
-            reporter.write(&mut GitLabReporterVisitor::new(
-                console,
-                session.app.workspace.fs().working_directory(),
-            ))?;
-        }
-        ReportMode::Junit => {
-            let reporter = JunitReporter {
-                summary,
-                diagnostics_payload,
-                execution: execution.clone(),
-                verbose: cli_options.verbose,
-                working_directory: fs.working_directory().clone(),
-            };
-            reporter.write(&mut JunitReporterVisitor::new(console))?;
-        }
-        ReportMode::Checkstyle => {
-            let reporter = CheckstyleReporter {
-                summary,
-                diagnostics_payload,
-                execution: execution.clone(),
-                verbose: cli_options.verbose,
-                working_directory: fs.working_directory().clone(),
-            };
-            reporter
-                .write(&mut crate::reporter::checkstyle::CheckstyleReporterVisitor::new(console))?;
-        }
-        ReportMode::RdJson => {
-            let reporter = RdJsonReporter {
-                diagnostics_payload,
-                execution: execution.clone(),
-                verbose: cli_options.verbose,
-                working_directory: fs.working_directory().clone(),
-            };
-            reporter.write(&mut RdJsonReporterVisitor(console))?;
         }
     }