repopilot 0.11.0

Local-first CLI for repository audit, architecture risk detection, baseline tracking, and CI-friendly code review.
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

use crate::doctor::model::{DoctorCheck, DoctorStatus};
use std::path::Path;

const REPORT_FILE_PATH: &str = "repopilot-report.md";
const RECEIPT_FILE_PATH: &str = ".repopilot/receipt.json";

pub fn check_scan_scope(files_analyzed: usize) -> DoctorCheck {
    if files_analyzed > 0 {
        DoctorCheck {
            id: "scan_scope".to_string(),
            status: DoctorStatus::Pass,
            title: "Scan scope is not empty".to_string(),
            detail: format!("{files_analyzed} files analyzed."),
        }
    } else {
        DoctorCheck {
            id: "scan_scope".to_string(),
            status: DoctorStatus::Fail,
            title: "Scan scope is empty".to_string(),
            detail: "No files were analyzed. Check ignore rules, path, file size limits, and low-signal filtering."
                .to_string(),
        }
    }
}

pub fn check_scan_limit(files_skipped_by_limit: usize) -> DoctorCheck {
    if files_skipped_by_limit == 0 {
        DoctorCheck {
            id: "scan_limit".to_string(),
            status: DoctorStatus::Pass,
            title: "No scan limit truncation".to_string(),
            detail: "No files were skipped by --max-files.".to_string(),
        }
    } else {
        DoctorCheck {
            id: "scan_limit".to_string(),
            status: DoctorStatus::Warn,
            title: "Scan was truncated by max-files".to_string(),
            detail: format!("{files_skipped_by_limit} files were skipped by the scan limit."),
        }
    }
}

pub fn check_report_receipt_readiness(root: &Path) -> DoctorCheck {
    match report_receipt_paths_ready(root) {
        Ok(detail) => DoctorCheck {
            id: "report_receipt".to_string(),
            status: DoctorStatus::Pass,
            title: "Report and receipt paths are ready".to_string(),
            detail,
        },
        Err(detail) => DoctorCheck {
            id: "report_receipt".to_string(),
            status: DoctorStatus::Fail,
            title: "Report or receipt path is blocked".to_string(),
            detail,
        },
    }
}

pub fn report_receipt_paths_ready(root: &Path) -> Result<String, String> {
    let report_path = root.join(REPORT_FILE_PATH);
    let repopilot_dir = root.join(".repopilot");
    let receipt_path = root.join(RECEIPT_FILE_PATH);

    if report_path.is_dir() {
        return Err(format!(
            "{} is a directory; choose another report output path.",
            report_path.display()
        ));
    }

    if repopilot_dir.is_file() {
        return Err(format!(
            "{} is a file; RepoPilot needs a directory for receipt output.",
            repopilot_dir.display()
        ));
    }

    if receipt_path.is_dir() {
        return Err(format!(
            "{} is a directory; choose another receipt output path.",
            receipt_path.display()
        ));
    }

    Ok(format!(
        "Default adoption outputs are available: `{REPORT_FILE_PATH}` and `{RECEIPT_FILE_PATH}`."
    ))
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::tempdir;

    #[test]
    fn report_and_receipt_paths_are_ready_by_default() {
        let dir = tempdir().expect("tempdir should be created");

        let check = check_report_receipt_readiness(dir.path());

        assert_eq!(check.status, DoctorStatus::Pass);
        assert!(check.detail.contains(RECEIPT_FILE_PATH));
    }
}