sqlt 0.3.2

SQL parser, translator, and linter for MySQL, MariaDB, Postgres, MSSQL, SQLite
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! SARIF 2.1.0 output (GitHub code-scanning subset).
//!
//! We hand-build the SARIF tree as a `serde_json::Value` rather than pull a
//! SARIF crate — the surface we need is small and stable, and avoiding the
//! dep keeps the binary lean.
//!
//! Reference: <https://docs.oasis-open.org/sarif/sarif/v2.1.0/sarif-v2.1.0.html>

use serde_json::{Value, json};

use crate::lint::Diagnostic;
use crate::lint::registry;

pub fn render(source: &str, diagnostics: &[Diagnostic]) -> String {
    // Build the rules section by inspecting the registry once. SARIF wants
    // every rule referenced in `results` to be declared in `tool.driver.rules`.
    let all = registry::all_rules();
    let rules_json: Vec<Value> = all
        .iter()
        .map(|r| {
            let m = r.meta();
            json!({
                "id": m.id.as_str(),
                "name": m.name,
                "shortDescription": { "text": m.summary },
                "fullDescription":  { "text": m.explanation },
                "defaultConfiguration": { "level": m.default_severity.sarif_level() },
                "properties": { "tags": ["sql", m.category.as_str()] }
            })
        })
        .collect();

    let results: Vec<Value> = diagnostics
        .iter()
        .map(|d| {
            let mut location = json!({
                "physicalLocation": {
                    "artifactLocation": { "uri": source }
                }
            });
            if d.has_span() {
                location["physicalLocation"]["region"] = json!({
                    "startLine":   d.span.start.line,
                    "startColumn": d.span.start.column,
                    "endLine":     d.span.end.line,
                    "endColumn":   d.span.end.column,
                });
            }
            json!({
                "ruleId": d.rule.as_str(),
                "level": d.severity.sarif_level(),
                "message": { "text": d.message },
                "locations": [location]
            })
        })
        .collect();

    let sarif = json!({
        "$schema": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/cos02/schemas/sarif-schema-2.1.0.json",
        "version": "2.1.0",
        "runs": [{
            "tool": {
                "driver": {
                    "name": "sqlt",
                    "version": env!("CARGO_PKG_VERSION"),
                    "informationUri": "https://github.com/thomasbjork/sqlt",
                    "rules": rules_json
                }
            },
            "results": results
        }]
    });
    serde_json::to_string_pretty(&sarif).expect("serialize sarif")
}