Add SARIF output format for report #4

Cargo.toml

@@ -70,6 +70,7 @@ tracing-log = "0.1"
 tracing-subscriber = { version = "0.3", features = ["tracing-log", "ansi"] }
 url = "2.3"
 walkdir = "2.3"
+serde-sarif = "0.3.5"
 
 [dev-dependencies]
 assert_cmd = { version = "2.0", features = ["color-auto"] }

src/bin/noseyparker/args.rs

@@ -450,6 +450,12 @@ pub enum OutputFormat {
     ///
     /// This is a sequence of JSON objects, one per line.
     Jsonl,
+
+    /// SARIF format
+    ///
+    /// This is a JSON-based format used by Microsoft's Static Application Security Testing (SAST) tool.
+    /// See https://github.com/microsoft/sarif-tutorials
+    Sarif,
 }
 
 impl std::fmt::Display for OutputFormat {
@@ -458,6 +464,7 @@ impl std::fmt::Display for OutputFormat {
             OutputFormat::Human => "human",
             OutputFormat::Json => "json",
             OutputFormat::Jsonl => "jsonl",
+            OutputFormat::Sarif => "sarif",
         };
         write!(f, "{s}")
     }
@@ -470,6 +477,7 @@ pub trait Reportable {
     fn human_format<W: std::io::Write>(&self, writer: W) -> Result<()>;
     fn json_format<W: std::io::Write>(&self, writer: W) -> Result<()>;
     fn jsonl_format<W: std::io::Write>(&self, writer: W) -> Result<()>;
+    fn sarif_format<W: std::io::Write>(&self, writer: W) -> Result<()>;
 
     fn report(&self, output_args: &OutputArgs) -> Result<()> {
         let writer = output_args
@@ -480,6 +488,7 @@ pub trait Reportable {
             OutputFormat::Human => self.human_format(writer),
             OutputFormat::Json => self.json_format(writer),
             OutputFormat::Jsonl => self.jsonl_format(writer),
+            OutputFormat::Sarif => self.sarif_format(writer),
         };
         match result {
             Ok(()) => Ok(()),

src/bin/noseyparker/cmd_github.rs

@@ -46,4 +46,8 @@ impl Reportable for RepoReporter {
         }
         Ok(())
     }
+
+    fn sarif_format<W: std::io::Write>(&self, _writer: W) -> Result<()> {
+        bail!("SARIF output not supported for this command")
+    }
 }