feat: Add support for --sarif flag to qlty smells command (#2037)

This PR adds support for generating SARIF output using the --sarif flag
when running the `qlty smells` command.


---

Notes:

I'm not an expert in Rust, and I encountered a few challenges while
implementing this feature, so happy for any comments to improve it.

The main issue was that the existing `SarifFormatter` only supported a
single type: `qlty_check::Report`. Since Rust doesn't have inheritance,
I resolved this by extracting a shared trait (`SarifTrait`) and
implementing it for both `qlty_check::Report` and
`qlty_analysis::Report`. The `SarifFormatter` was then updated to accept
any type that implements this trait.

I'm not completely confident that all the structs and traits are placed
in the most appropriate modules, so I'm open to feedback or suggestions
about how to better organize them according to project conventions or
best practices.

Author: ujlbu4

qlty-cli/src/commands/check.rs

@@ -363,7 +363,7 @@ impl Check {
             formatter.write_to(&mut std::io::stdout())?;
             Ok(false)
         } else if self.sarif {
-            let formatter = SarifFormatter::boxed(report.clone());
+            let formatter = SarifFormatter::boxed(report.messages.clone(), report.issues.clone());
             formatter.write_to(&mut std::io::stdout())?;
             Ok(false)
         } else {

qlty-cli/src/commands/smells.rs

@@ -1,3 +1,4 @@
+use crate::format::SarifFormatter;
 use crate::ui::Highlighter;
 use crate::ui::Steps;
 use crate::{Arguments, CommandError, CommandSuccess};
@@ -46,9 +47,13 @@ pub struct Smells {
     pub quiet: bool,
 
     /// JSON output
-    #[arg(long, hide = true)]
+    #[arg(long, hide = true, conflicts_with = "sarif")]
     json: bool,
 
+    /// SARIF output
+    #[arg(long, conflicts_with = "json")]
+    sarif: bool,
+
     /// Files to analyze
     pub paths: Vec<PathBuf>,
 }
@@ -101,7 +106,7 @@ impl Smells {
 
         steps.start(SPARKLES, "Reporting... ");
         println!();
-        self.write_stdout(&workspace, &report.issues)?;
+        self.write_stdout(&workspace, &report)?;
 
         CommandSuccess::ok()
     }
@@ -207,11 +212,15 @@ impl Smells {
         Ok(executor.report())
     }
 
-    fn write_stdout(&self, workspace: &Workspace, issues: &[Issue]) -> Result<()> {
+    fn write_stdout(&self, workspace: &Workspace, report: &Report) -> Result<()> {
         if self.json {
-            self.write_stdout_json(issues)
+            self.write_stdout_json(&report.issues)
+        } else if self.sarif {
+            let formatter = SarifFormatter::boxed(report.messages.clone(), report.issues.clone());
+            formatter.write_to(&mut std::io::stdout())?;
+            Ok(())
         } else {
-            self.write_stdout_text(workspace, issues)
+            self.write_stdout_text(workspace, &report.issues)
         }
     }
 

qlty-cli/src/format/sarif.rs

@@ -1,5 +1,4 @@
 use anyhow::Result;
-use qlty_check::Report;
 use qlty_config::version::{BUILD_DATE, LONG_VERSION, QLTY_VERSION};
 use qlty_formats::Formatter;
 use qlty_types::analysis::v1::{Category, Issue, Language, Level, Location, Message, MessageLevel};
@@ -9,16 +8,17 @@ use std::io::Write;
 
 #[derive(Debug)]
 pub struct SarifFormatter {
-    report: Report,
+    pub messages: Vec<Message>,
+    pub issues: Vec<Issue>,
 }
 
 impl SarifFormatter {
-    pub fn new(report: Report) -> Self {
-        Self { report }
+    pub fn new(messages: Vec<Message>, issues: Vec<Issue>) -> Self {
+        Self { messages, issues }
     }
 
-    pub fn boxed(report: Report) -> Box<dyn Formatter> {
-        Box::new(Self::new(report))
+    pub fn boxed(messages: Vec<Message>, issues: Vec<Issue>) -> Box<dyn Formatter> {
+        Box::new(Self::new(messages, issues))
     }
 
     fn convert_level(&self, level: Level) -> &'static str {
@@ -267,7 +267,7 @@ impl SarifFormatter {
         let mut rules = vec![];
         let mut rule_ids = std::collections::HashSet::new();
 
-        for issue in &self.report.issues {
+        for issue in &self.issues {
             if !rule_ids.contains(&issue.rule_key) {
                 rule_ids.insert(issue.rule_key.clone());
 
@@ -284,14 +284,12 @@ impl SarifFormatter {
         }
 
         let results = self
-            .report
             .issues
             .iter()
             .map(|issue| self.serialize_issue(issue))
             .collect::<Vec<_>>();
 
         let notifications = self
-            .report
             .messages
             .iter()
             .map(|message| self.serialize_notification(message))
@@ -339,6 +337,7 @@ impl Formatter for SarifFormatter {
 mod test {
     use super::*;
     use qlty_analysis::{workspace_entries::TargetMode, IssueCount};
+    use qlty_check::Report;
     use qlty_types::analysis::v1::{
         Category, ExecutionVerb, Mode, Range, Replacement, Suggestion, SuggestionSource,
     };
@@ -494,7 +493,7 @@ mod test {
             counts: IssueCount::default(),
         };
 
-        let formatter = SarifFormatter::boxed(report);
+        let formatter = SarifFormatter::boxed(report.messages.clone(), report.issues.clone());
         let output = formatter.read().unwrap();
         let output_str = String::from_utf8_lossy(&output);