duck-diagnostic 0.3.1

Generic diagnostic engine for building rich error reporting into any tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! JSON output mode. Stable schema for IDE / LSP / CI consumers.

use crate::diagnostic::{Diagnostic, DiagnosticCode};
use serde::Serialize;

#[derive(Serialize)]
struct JsonDiag<'a, C: DiagnosticCode + Serialize> {
  code: &'a str,
  severity: crate::diagnostic::Severity,
  message: &'a str,
  url: Option<&'static str>,
  labels: &'a [crate::diagnostic::Label],
  notes: &'a [String],
  help: &'a Option<String>,
  suggestions: &'a [crate::diagnostic::Suggestion],
  #[serde(skip_serializing_if = "Option::is_none")]
  raw_code: Option<&'a C>,
}

pub(crate) fn format_all_json<C: DiagnosticCode + Serialize>(
  diagnostics: &[Diagnostic<C>],
) -> String {
  let view: Vec<JsonDiag<C>> = diagnostics
    .iter()
    .map(|d| JsonDiag {
      code: d.code.code(),
      severity: d.severity,
      message: &d.message,
      url: d.code.url(),
      labels: &d.labels,
      notes: &d.notes,
      help: &d.help,
      suggestions: &d.suggestions,
      raw_code: Some(&d.code),
    })
    .collect();
  serde_json::to_string_pretty(&view).unwrap_or_else(|_| "[]".to_string())
}