feat(reporting): add gitlab code quality format (#62)

Cargo.toml

@@ -86,6 +86,7 @@ self_update = { version = "0.42.0", features = ["archive-tar", "archive-zip", "c
 openssl = { version = "0.10", features = ["vendored"] }
 tempfile = "3.15.0"
 colored = "3.0.0"
+blake3 = "1.5.5"
 
 [lints]
 workspace = true

crates/reporting/Cargo.toml

@@ -23,3 +23,4 @@ serde_json = { workspace = true }
 codespan-reporting = { workspace = true }
 termcolor = { workspace = true }
 strum = { workspace = true }
+blake3 = { workspace = true }

crates/reporting/src/internal/emitter/gitlab.rs

@@ -0,0 +1,89 @@
+use mago_interner::ThreadedInterner;
+use mago_source::HasSource;
+use mago_source::SourceManager;
+
+use serde::Serialize;
+use termcolor::WriteColor;
+
+use crate::error::ReportingError;
+use crate::IssueCollection;
+use crate::Level;
+
+use super::utils::long_message;
+
+#[derive(Serialize)]
+struct CodeQualityIssue<'a> {
+    description: String,
+    check_name: &'a str,
+    fingerprint: String,
+    severity: &'a str,
+    location: Location,
+}
+
+#[derive(Serialize)]
+struct Location {
+    path: String,
+    lines: Lines,
+}
+
+#[derive(Serialize)]
+struct Lines {
+    begin: usize,
+}
+
+pub fn gitlab_format(
+    writer: &mut dyn WriteColor,
+    sources: &SourceManager,
+    interner: &ThreadedInterner,
+    issues: IssueCollection,
+) -> Result<Option<Level>, ReportingError> {
+    let highest_level = issues.get_highest_level();
+
+    let code_quality_issues = issues
+        .iter()
+        .map(|issue| {
+            let severity = match &issue.level {
+                Level::Note | Level::Help => "info",
+                Level::Warning => "minor",
+                Level::Error => "major",
+            };
+
+            let (path, line) = match issue.annotations.iter().find(|annotation| annotation.is_primary()) {
+                Some(annotation) => {
+                    let source = sources.load(&annotation.span.source()).unwrap();
+
+                    let file_path = interner.lookup(&source.identifier.0).to_string();
+                    let line = source.line_number(annotation.span.start.offset) + 1;
+
+                    (file_path, line)
+                }
+                None => ("<unknown>".to_string(), 0),
+            };
+
+            let description = long_message(issue);
+
+            let check_name = issue.code.as_deref().unwrap_or("other");
+
+            let fingerprint = {
+                let mut hasher = blake3::Hasher::new();
+                hasher.update(check_name.as_bytes());
+                hasher.update(path.as_bytes());
+                hasher.update(line.to_le_bytes().as_slice());
+                hasher.update(description.as_bytes());
+                hasher.finalize().to_hex()[..32].to_string()
+            };
+
+            CodeQualityIssue {
+                description,
+                check_name,
+                fingerprint,
+                severity,
+                location: Location { path, lines: Lines { begin: line } },
+            }
+        })
+        .collect::<Vec<_>>();
+
+    serde_json::to_writer_pretty(writer, &code_quality_issues)?;
+
+    Ok(highest_level)
+}

crates/reporting/src/internal/emitter/mod.rs

@@ -15,6 +15,7 @@ pub mod codespan;
 pub mod count;
 pub mod emacs;
 pub mod github;
+pub mod gitlab;
 pub mod json;
 
 pub trait Emitter {
@@ -60,6 +61,7 @@ impl Emitter for ReportingFormat {
             ReportingFormat::Medium => codespan::medium_format.emit(writer, sources, interner, issues),
             ReportingFormat::Short => codespan::short_format.emit(writer, sources, interner, issues),
             ReportingFormat::Github => github::github_format.emit(writer, sources, interner, issues),
+            ReportingFormat::Gitlab => gitlab::gitlab_format.emit(writer, sources, interner, issues),
             ReportingFormat::Json => json::json_format.emit(writer, sources, interner, issues),
             ReportingFormat::Count => count::count_format.emit(writer, sources, interner, issues),
             ReportingFormat::Checkstyle => checkstyle::checkstyle_format.emit(writer, sources, interner, issues),

crates/reporting/src/reporter.rs

@@ -37,6 +37,7 @@ pub enum ReportingFormat {
     Medium,
     Short,
     Github,
+    Gitlab,
     Json,
     Count,
     Checkstyle,
@@ -99,6 +100,7 @@ impl FromStr for ReportingFormat {
             "medium" => Ok(Self::Medium),
             "short" => Ok(Self::Short),
             "github" => Ok(Self::Github),
+            "gitlab" => Ok(Self::Gitlab),
             "json" => Ok(Self::Json),
             "count" => Ok(Self::Count),
             "checkstyle" => Ok(Self::Checkstyle),