ailint-core 1.0.1

Core library for ailint: discovery, parsing, rule engine, and reporters for AI agent guidance files.
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

//! SARIF 2.1.0 output for GitHub code scanning.

use std::io::Write;

use anyhow::Result;
use serde_json::json;
use serde_sarif::sarif::{
    ArtifactChange, ArtifactLocation, Fix, Location, Message, MultiformatMessageString,
    PhysicalLocation, Region, ReportingConfiguration, ReportingDescriptor, Result as SarifResult,
    Run, Sarif, Tool, ToolComponent,
};

use crate::reporter::Reporter;
use crate::rules::{registry, Severity, Violation};
use crate::VERSION;

const INFORMATION_URI: &str = "https://github.com/jamesmhall/ailint";
const SCHEMA_URI: &str = "https://json.schemastore.org/sarif-2.1.0.json";

/// Renders violations as a SARIF 2.1.0 log.
#[derive(Debug, Default)]
pub struct SarifReporter;

impl Reporter for SarifReporter {
    fn report(&self, violations: &[Violation], out: &mut dyn Write) -> Result<()> {
        let rules = build_rule_descriptors();
        let results = violations.iter().map(build_result).collect::<Vec<_>>();

        let driver = ToolComponent::builder()
            .name("ailint".to_string())
            .information_uri(INFORMATION_URI.to_string())
            .version(VERSION.to_string())
            .rules(rules)
            .build();

        let tool = Tool::builder().driver(driver).build();

        let run = Run::builder().tool(tool).results(results).build();

        let sarif = Sarif::builder()
            .version(json!("2.1.0"))
            .schema(SCHEMA_URI.to_string())
            .runs(vec![run])
            .build();

        serde_json::to_writer_pretty(&mut *out, &sarif)?;
        writeln!(out)?;
        Ok(())
    }
}

fn build_rule_descriptors() -> Vec<ReportingDescriptor> {
    let mut descriptors = Vec::new();
    for rule in registry::all_rules() {
        descriptors.push(descriptor_for(
            rule.id().code_str(),
            rule.id().slug,
            rule.default_severity(),
        ));
    }
    for rule in registry::all_batch_rules() {
        descriptors.push(descriptor_for(
            rule.id().code_str(),
            rule.id().slug,
            rule.default_severity(),
        ));
    }
    descriptors
}

fn descriptor_for(id: String, slug: &'static str, severity: Severity) -> ReportingDescriptor {
    let short_description = MultiformatMessageString::builder()
        .text(slug.to_string())
        .build();
    let default_configuration = ReportingConfiguration::builder()
        .level(json!(sarif_level(severity)))
        .build();
    ReportingDescriptor::builder()
        .id(id)
        .name(slug.to_string())
        .short_description(short_description)
        .help_uri(format!("https://github.com/jamesmhall/ailint#{slug}"))
        .default_configuration(default_configuration)
        .build()
}

fn build_result(v: &Violation) -> SarifResult {
    let message = Message::builder().text(v.message.clone()).build();

    let artifact_location = ArtifactLocation::builder()
        .uri(v.file.to_string_lossy().into_owned())
        .build();
    let region = Region::builder()
        .start_line(v.line.unwrap_or(1) as i64)
        .start_column(v.column.unwrap_or(1) as i64)
        .build();
    let physical_location = PhysicalLocation::builder()
        .artifact_location(artifact_location)
        .region(region)
        .build();
    let location = Location::builder()
        .physical_location(physical_location)
        .build();

    let builder = SarifResult::builder()
        .rule_id(v.rule_id.code_str())
        .level(json!(sarif_level(v.severity)))
        .message(message)
        .locations(vec![location]);

    match v.fix_hint.as_ref() {
        Some(hint) => builder.fixes(vec![fix_from_hint(hint, v)]).build(),
        None => builder.build(),
    }
}

fn fix_from_hint(hint: &str, v: &Violation) -> Fix {
    let description = Message::builder().text(hint.to_string()).build();
    let artifact_location = ArtifactLocation::builder()
        .uri(v.file.to_string_lossy().into_owned())
        .build();
    let change = ArtifactChange::builder()
        .artifact_location(artifact_location)
        .build();
    Fix::builder()
        .description(description)
        .artifact_changes(vec![change])
        .build()
}

fn sarif_level(severity: Severity) -> &'static str {
    match severity {
        Severity::Error => "error",
        Severity::Warning => "warning",
        Severity::Info => "note",
    }
}