heal-cli 0.4.0

Hook-driven Evaluation & Autonomous Loop — code-health harness CLI for AI coding agents
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use std::path::PathBuf;

use heal_cli::core::doc_pairs::{DocPair, DocPairsFile, PairSource, DOC_PAIRS_VERSION};

fn write(project: &std::path::Path, rel: &str, body: &str) {
    let abs = project.join(rel);
    if let Some(parent) = abs.parent() {
        std::fs::create_dir_all(parent).unwrap();
    }
    std::fs::write(&abs, body).unwrap();
}

#[test]
fn read_returns_none_when_missing() {
    let dir = tempfile::tempdir().unwrap();
    let got = DocPairsFile::read(dir.path(), ".heal/doc_pairs.json").unwrap();
    assert!(got.is_none());
}

#[test]
fn read_round_trips_full_entry() {
    let dir = tempfile::tempdir().unwrap();
    let body = r#"{
        "version": 1,
        "pairs": [
            {
                "doc": "docs/cli.md",
                "srcs": ["src/cli.rs"],
                "confidence": 0.85,
                "source": "mention"
            }
        ]
    }"#;
    write(dir.path(), ".heal/doc_pairs.json", body);
    let parsed = DocPairsFile::read(dir.path(), ".heal/doc_pairs.json")
        .unwrap()
        .expect("file present");
    assert_eq!(parsed.version, DOC_PAIRS_VERSION);
    assert_eq!(parsed.pairs.len(), 1);
    assert_eq!(parsed.pairs[0].doc, "docs/cli.md");
    assert_eq!(parsed.pairs[0].srcs, vec!["src/cli.rs".to_string()]);
    assert_eq!(parsed.pairs[0].confidence, Some(0.85));
    assert_eq!(parsed.pairs[0].source, Some(PairSource::Mention));
}

#[test]
fn read_treats_unknown_version_as_absent() {
    let dir = tempfile::tempdir().unwrap();
    // version 999 ⇒ schema mismatch ⇒ silently invalidate so the user
    // can rerun the generator without a hard parse error.
    let body = r#"{"version": 999, "pairs": []}"#;
    write(dir.path(), ".heal/doc_pairs.json", body);
    let got = DocPairsFile::read(dir.path(), ".heal/doc_pairs.json").unwrap();
    assert!(got.is_none());
}

#[test]
fn read_rejects_malformed_json() {
    let dir = tempfile::tempdir().unwrap();
    write(dir.path(), ".heal/doc_pairs.json", "{ not json }");
    let err = DocPairsFile::read(dir.path(), ".heal/doc_pairs.json").unwrap_err();
    let s = format!("{err}");
    assert!(s.contains("invalid cache record"), "got: {s}");
}

#[test]
fn read_rejects_unknown_fields() {
    let dir = tempfile::tempdir().unwrap();
    let body = r#"{
        "version": 1,
        "pairs": [],
        "bogus_top_level": true
    }"#;
    write(dir.path(), ".heal/doc_pairs.json", body);
    assert!(DocPairsFile::read(dir.path(), ".heal/doc_pairs.json").is_err());
}

#[test]
fn integrity_check_clean_when_all_paths_exist() {
    let dir = tempfile::tempdir().unwrap();
    write(dir.path(), "docs/cli.md", "# CLI\n");
    write(dir.path(), "src/cli.rs", "fn main() {}\n");
    let file = DocPairsFile {
        version: DOC_PAIRS_VERSION,
        pairs: vec![DocPair {
            doc: "docs/cli.md".into(),
            srcs: vec!["src/cli.rs".into()],
            confidence: None,
            source: Some(PairSource::Manual),
        }],
    };
    assert!(file.integrity_check(dir.path()).is_empty());
}

#[test]
fn integrity_check_reports_missing_paths() {
    let dir = tempfile::tempdir().unwrap();
    write(dir.path(), "docs/cli.md", "# CLI\n");
    // src/cli.rs intentionally absent.
    let file = DocPairsFile {
        version: DOC_PAIRS_VERSION,
        pairs: vec![DocPair {
            doc: "docs/cli.md".into(),
            srcs: vec!["src/cli.rs".into()],
            confidence: None,
            source: None,
        }],
    };
    let warnings = file.integrity_check(dir.path());
    assert_eq!(warnings.len(), 1);
    assert_eq!(warnings[0].pair_index, 0);
    assert_eq!(warnings[0].missing_path, PathBuf::from("src/cli.rs"));
}

#[test]
fn live_pairs_filters_dangling_entries() {
    let dir = tempfile::tempdir().unwrap();
    write(dir.path(), "docs/a.md", "");
    write(dir.path(), "src/a.rs", "");
    // Pair 1 healthy; pair 2 has a missing src; pair 3 missing doc.
    let file = DocPairsFile {
        version: DOC_PAIRS_VERSION,
        pairs: vec![
            DocPair {
                doc: "docs/a.md".into(),
                srcs: vec!["src/a.rs".into()],
                confidence: None,
                source: None,
            },
            DocPair {
                doc: "docs/a.md".into(),
                srcs: vec!["src/missing.rs".into()],
                confidence: None,
                source: None,
            },
            DocPair {
                doc: "docs/missing.md".into(),
                srcs: vec!["src/a.rs".into()],
                confidence: None,
                source: None,
            },
        ],
    };
    let live = file.live_pairs(dir.path());
    assert_eq!(live.len(), 1);
    assert_eq!(live[0].doc, "docs/a.md");
}

#[test]
fn pair_source_serializes_snake_case() {
    let pair = DocPair {
        doc: "x.md".into(),
        srcs: vec!["x.rs".into()],
        confidence: None,
        source: Some(PairSource::Llm),
    };
    let s = serde_json::to_string(&pair).unwrap();
    assert!(s.contains("\"llm\""), "got: {s}");
}