patholog 1.0.0

Diagnose, explain, clean, and safely repair PATH behavior.
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

use crate::model::{ResolutionCandidate, ResolutionReport};

use super::shared::finish_lines;

pub(crate) fn format_why(report: &ResolutionReport) -> String {
    let mut lines = vec![format!("Command: {}", report.command), String::new()];
    let Some(winner) = winner(&report.candidates) else {
        lines.push("Not found in PATH.".to_owned());
        lines.push(String::new());
        lines.push("Searched directories:".to_owned());
        lines.extend(
            report
                .searched_directories
                .iter()
                .enumerate()
                .map(|(index, directory)| format!("  {}  {directory}", index + 1)),
        );
        append_related_hints(&mut lines, report);
        return finish_lines(lines);
    };

    lines.extend([
        "Resolved to:".to_owned(),
        format!("  {}", winner.path),
        String::new(),
        "Why:".to_owned(),
        format!(
            "  entry {} ({}) appears before all other matching PATH entries.",
            winner.entry_index, winner.directory
        ),
        String::new(),
        "Other matches:".to_owned(),
    ]);

    append_other_matches(&mut lines, report);
    finish_lines(lines)
}

pub(crate) fn format_conflicts(report: &ResolutionReport) -> String {
    if report.candidates.is_empty() {
        return format!("No matches for {}\n", report.command);
    }

    finish_lines(report.candidates.iter().map(|candidate| {
        let marker = if candidate.wins { "*" } else { " " };
        format!("{}{marker} {}", candidate.entry_index, candidate.path)
    }))
}

fn winner(candidates: &[ResolutionCandidate]) -> Option<&ResolutionCandidate> {
    candidates.iter().find(|candidate| candidate.wins)
}

fn append_other_matches(lines: &mut Vec<String>, report: &ResolutionReport) {
    let other_matches = report
        .candidates
        .iter()
        .filter(|candidate| !candidate.wins)
        .collect::<Vec<_>>();
    if other_matches.is_empty() {
        lines.push("  none".to_owned());
    } else {
        lines.extend(
            other_matches
                .iter()
                .map(|candidate| format!("  {}  {}", candidate.entry_index, candidate.path)),
        );
    }
}

fn append_related_hints(lines: &mut Vec<String>, report: &ResolutionReport) {
    if report.related_hints.is_empty() {
        return;
    }

    lines.push(String::new());
    lines.push("Related executables, not PATH matches:".to_owned());
    for hint in &report.related_hints {
        lines.push(format!("  {}", hint.command));
        lines.extend(hint.paths.iter().map(|path| format!("    {path}")));
    }
}