pathlint 0.0.24

Lint the PATH environment variable against declarative ordering rules.
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

//! Runtime OS classification used by `[[expect]] os = [...]` filters and
//! `[source.<name>]` per-OS keys.
//!
//! # Examples
//!
//! ```
//! use pathlint::os_detect::{Os, os_filter_applies};
//!
//! assert!(Os::Linux.matches_tag("linux"));
//! assert!(Os::Linux.matches_tag("unix"));
//! assert!(!Os::Linux.matches_tag("windows"));
//!
//! // No `os` filter → applies to every OS.
//! assert!(os_filter_applies(&None, Os::Linux));
//! ```

use std::env;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Os {
    Windows,
    Macos,
    Linux,
    Termux,
}

impl Os {
    pub fn current() -> Self {
        if cfg!(windows) {
            Os::Windows
        } else if cfg!(target_os = "macos") {
            Os::Macos
        } else if is_termux() {
            Os::Termux
        } else {
            Os::Linux
        }
    }

    /// Returns true if the OS tag string from a TOML file matches this OS.
    /// Tags: "windows", "macos", "linux", "termux", "unix".
    pub fn matches_tag(self, tag: &str) -> bool {
        let t = tag.to_ascii_lowercase();
        matches!(
            (self, t.as_str()),
            (Os::Windows, "windows")
                | (Os::Macos, "macos")
                | (Os::Linux, "linux")
                | (Os::Termux, "termux")
                | (Os::Macos | Os::Linux | Os::Termux, "unix")
        )
    }

    pub fn as_str(self) -> &'static str {
        match self {
            Os::Windows => "windows",
            Os::Macos => "macos",
            Os::Linux => "linux",
            Os::Termux => "termux",
        }
    }
}

fn is_termux() -> bool {
    env::var("PREFIX")
        .map(|p| p.contains("/data/data/com.termux/files"))
        .unwrap_or(false)
}

/// Decide whether an `[[expect]] os = [...]` filter accepts the
/// current OS. `None` means "applies on every OS"; otherwise any
/// matching tag wins. Pure: takes the rule's optional tag list and
/// the current OS, no globals. Used by both `lint::evaluate_one`
/// and `sort::sort_path` so the filter contract stays in one
/// place.
pub fn os_filter_applies(os_filter: &Option<Vec<String>>, os: Os) -> bool {
    match os_filter {
        None => true,
        Some(tags) => tags.iter().any(|t| os.matches_tag(t)),
    }
}

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

    #[test]
    fn windows_matches_windows_and_not_unix() {
        assert!(Os::Windows.matches_tag("windows"));
        assert!(!Os::Windows.matches_tag("unix"));
        assert!(!Os::Windows.matches_tag("linux"));
    }

    #[test]
    fn macos_matches_unix() {
        assert!(Os::Macos.matches_tag("macos"));
        assert!(Os::Macos.matches_tag("unix"));
        assert!(!Os::Macos.matches_tag("linux"));
    }

    #[test]
    fn termux_matches_unix_but_not_linux() {
        assert!(Os::Termux.matches_tag("termux"));
        assert!(Os::Termux.matches_tag("unix"));
        assert!(!Os::Termux.matches_tag("linux"));
    }

    #[test]
    fn tag_match_is_case_insensitive() {
        assert!(Os::Linux.matches_tag("LINUX"));
        assert!(Os::Linux.matches_tag("Unix"));
    }
}