feat: implement sarif format reporter

crate-ci · Jun 29, 2024 · 50550f1 · 50550f1
1 parent c16dc8f
commit 50550f1
Show file tree

Hide file tree

Showing 7 changed files with 350 additions and 11 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/typos-cli/Cargo.toml b/crates/typos-cli/Cargo.toml
@@ -77,6 +77,7 @@ colorchoice-clap = "1.0.3"
 serde_regex = "1.1.0"
 regex = "1.10.4"
 encoding_rs = "0.8.34"
+serde-sarif = "0.4.2"
 
 [dev-dependencies]
 assert_fs = "1.1"

diff --git a/crates/typos-cli/src/bin/typos-cli/args.rs b/crates/typos-cli/src/bin/typos-cli/args.rs
@@ -10,6 +10,7 @@ pub(crate) enum Format {
     #[default]
     Long,
     Json,
+    Sarif,
 }
 
 impl Format {
@@ -19,6 +20,7 @@ impl Format {
             Format::Brief => Box::new(crate::report::PrintBrief),
             Format::Long => Box::new(crate::report::PrintLong),
             Format::Json => Box::new(crate::report::PrintJson),
+            Format::Sarif => Box::new(crate::report::PrintSarif::default()),
         }
     }
 }

diff --git a/crates/typos-cli/src/bin/typos-cli/main.rs b/crates/typos-cli/src/bin/typos-cli/main.rs
@@ -2,12 +2,13 @@ use std::io::{BufRead as _, BufReader, Write as _};
 use std::path::PathBuf;
 
 use clap::Parser;
+use proc_exit::prelude::*;
+
+use typos_cli::report::Report;
 
 mod args;
 mod report;
 
-use proc_exit::prelude::*;
-
 fn main() {
     human_panic::setup_panic!();
     let result = run();
@@ -316,6 +317,8 @@ fn run_checks(args: &args::Args) -> proc_exit::ExitResult {
         if status_reporter.errors_found() {
             errors_found = true;
         }
+
+        status_reporter.finalize().unwrap();
     }
 
     if errors_found {