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

use std::path::PathBuf;

use ailint_core::{lint, Config};

fn fixture(rule_dir: &str, kind: &str, name: &str) -> PathBuf {
    let mut p = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    p.push("tests/fixtures/structural");
    p.push(rule_dir);
    p.push(kind);
    p.push(name);
    p
}

#[test]
fn ail001_fires_on_invalid_frontmatter() {
    let path = fixture("frontmatter_schema", "bad", "AGENTS.md");
    let violations = lint(&path, &Config::default()).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 1).collect();
    assert_eq!(hits.len(), 1, "expected one AIL001, got {violations:?}");
    assert!(hits[0].message.starts_with("invalid YAML frontmatter"));
    assert!(hits[0].fix_hint.is_some());
}

#[test]
fn ail001_silent_on_valid_frontmatter() {
    let path = fixture("frontmatter_schema", "good", "AGENTS.md");
    let violations = lint(&path, &Config::default()).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 1).collect();
    assert!(hits.is_empty(), "expected no AIL001, got {violations:?}");
}

fn config_with_required_setup() -> Config {
    let mut cfg = Config::default();
    let opts: serde_yaml::Value = serde_yaml::from_str("required: [\"Setup\"]").unwrap();
    cfg.rules
        .options
        .insert("missing-required-section".to_string(), opts);
    cfg
}

#[test]
fn ail003_fires_when_required_section_missing() {
    let path = fixture("required_section", "bad", "AGENTS.md");
    let cfg = config_with_required_setup();
    let violations = lint(&path, &cfg).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 3).collect();
    assert_eq!(hits.len(), 1, "expected one AIL003, got {violations:?}");
    assert!(hits[0].message.contains("Setup"));
}

#[test]
fn ail003_silent_when_required_section_present() {
    let path = fixture("required_section", "good", "AGENTS.md");
    let cfg = config_with_required_setup();
    let violations = lint(&path, &cfg).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 3).collect();
    assert!(hits.is_empty(), "expected no AIL003, got {violations:?}");
}

#[test]
fn ail040_fires_on_broken_link() {
    let path = fixture("broken_local_link", "bad", "doc.md");
    let violations = lint(&path, &Config::default()).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 40).collect();
    assert_eq!(hits.len(), 1, "expected one AIL040, got {violations:?}");
    assert!(hits[0].message.contains("does-not-exist.md"));
    assert!(hits[0].fix_hint.is_some());
}

#[test]
fn ail040_silent_on_valid_links() {
    let dir = {
        let mut p = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
        p.push("tests/fixtures/structural/broken_local_link/good");
        p
    };
    let violations = lint(&dir, &Config::default()).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 40).collect();
    assert!(hits.is_empty(), "expected no AIL040, got {violations:?}");
}

#[test]
fn ail041_fires_on_malformed_yaml() {
    let path = fixture("malformed_yaml", "bad", "config.yaml");
    let violations = lint(&path, &Config::default()).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 41).collect();
    assert_eq!(hits.len(), 1, "expected one AIL041, got {violations:?}");
    assert!(hits[0].message.contains("parse error"));
}

#[test]
fn ail041_silent_on_valid_yaml() {
    let path = fixture("malformed_yaml", "good", "config.yaml");
    let violations = lint(&path, &Config::default()).unwrap();
    let hits: Vec<_> = violations.iter().filter(|v| v.rule_id.code == 41).collect();
    assert!(hits.is_empty(), "expected no AIL041, got {violations:?}");
}