hk 1.45.0

A tool for managing git hooks
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

pub use std::env::*;
use std::{path::PathBuf, sync::LazyLock};

use indexmap::IndexSet;

use crate::git::StashMethod;

// pub static HK_BIN: LazyLock<PathBuf> =
//     LazyLock::new(|| current_exe().unwrap().canonicalize().unwrap());
// pub static CWD: LazyLock<PathBuf> = LazyLock::new(|| current_dir().unwrap_or_default());

pub static HOME_DIR: LazyLock<PathBuf> = LazyLock::new(|| dirs::home_dir().unwrap_or_default());
pub static HK_STATE_DIR: LazyLock<PathBuf> = LazyLock::new(|| {
    var_path("HK_STATE_DIR").unwrap_or(
        dirs::state_dir()
            .unwrap_or(HOME_DIR.join(".local").join("state"))
            .join("hk"),
    )
});
pub static HK_FILE: LazyLock<Option<String>> = LazyLock::new(|| var("HK_FILE").ok());
pub static HK_CACHE_DIR: LazyLock<PathBuf> = LazyLock::new(|| {
    var_path("HK_CACHE_DIR").unwrap_or(
        dirs::cache_dir()
            .unwrap_or(HOME_DIR.join(".cache"))
            .join("hk"),
    )
});
pub static XDG_CONFIG_HOME: LazyLock<PathBuf> =
    LazyLock::new(|| var_path("XDG_CONFIG_HOME").unwrap_or_else(|| HOME_DIR.join(".config")));
pub static HK_CONFIG_DIR: LazyLock<PathBuf> =
    LazyLock::new(|| var_path("HK_CONFIG_DIR").unwrap_or_else(|| XDG_CONFIG_HOME.join("hk")));
pub static HK_LOG: LazyLock<log::LevelFilter> = LazyLock::new(|| {
    var_log_level("HK_LOG")
        .or(var_log_level("HK_LOG_LEVEL"))
        .unwrap_or(log::LevelFilter::Info)
});
pub static HK_LOG_FILE_LEVEL: LazyLock<log::LevelFilter> =
    LazyLock::new(|| var_log_level("HK_LOG_FILE_LEVEL").unwrap_or(*HK_LOG));
pub static HK_LOG_FILE: LazyLock<PathBuf> =
    LazyLock::new(|| var_path("HK_LOG_FILE").unwrap_or(HK_STATE_DIR.join("hk.log")));

// When set, write a JSON timing report to this path after the hook finishes
pub static HK_TIMING_JSON: LazyLock<Option<PathBuf>> = LazyLock::new(|| var_path("HK_TIMING_JSON"));

pub static HK_LIBGIT2: LazyLock<bool> = LazyLock::new(|| !var_false("HK_LIBGIT2"));
pub static HK_HIDE_WHEN_DONE: LazyLock<bool> = LazyLock::new(|| var_true("HK_HIDE_WHEN_DONE"));
pub static HK_CHECK_FIRST: LazyLock<bool> = LazyLock::new(|| !var_false("HK_CHECK_FIRST"));
pub static HK_STASH: LazyLock<Option<StashMethod>> = LazyLock::new(|| {
    if var_false("HK_STASH") {
        Some(StashMethod::None)
    } else {
        var("HK_STASH")
            .map(|v| Some(v.parse().expect("invalid HK_STASH value")))
            .unwrap_or(None)
    }
});
pub static HK_STASH_UNTRACKED: LazyLock<bool> = LazyLock::new(|| !var_false("HK_STASH_UNTRACKED"));
pub static HK_FIX: LazyLock<bool> = LazyLock::new(|| !var_false("HK_FIX"));
pub static HK_MISE: LazyLock<bool> = LazyLock::new(|| var_true("HK_MISE"));
pub static HK_SKIP_STEPS: LazyLock<IndexSet<String>> = LazyLock::new(|| {
    var_csv("HK_SKIP_STEPS")
        .or(var_csv("HK_SKIP_STEP"))
        .unwrap_or_default()
});

// When true, allow output summaries to be printed in text mode
pub static HK_SUMMARY_TEXT: LazyLock<bool> = LazyLock::new(|| var_true("HK_SUMMARY_TEXT"));

// Cache control - defaults to enabled in release builds, disabled in debug builds
// Can be overridden with HK_CACHE=1 or HK_CACHE=0
pub static HK_CACHE: LazyLock<bool> = LazyLock::new(|| {
    var("HK_CACHE")
        .map(|_| !var_false("HK_CACHE"))
        .unwrap_or(!cfg!(debug_assertions)) // Default: enabled in release, disabled in debug
});

// Tracing configuration
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum TraceMode {
    Off,
    Text,
    Json,
}

pub static HK_TRACE: LazyLock<TraceMode> =
    LazyLock::new(|| match var("HK_TRACE").map(|v| v.to_lowercase()) {
        Ok(v) if v == "json" => TraceMode::Json,
        Ok(v) if v == "1" || v == "true" => TraceMode::Text,
        _ => TraceMode::Off,
    });

pub static HK_JSON: LazyLock<bool> = LazyLock::new(|| var_true("HK_JSON"));

pub static GIT_INDEX_FILE: LazyLock<Option<PathBuf>> = LazyLock::new(|| var_path("GIT_INDEX_FILE"));

pub static HK_PKL_HTTP_REWRITE: LazyLock<Option<String>> =
    LazyLock::new(|| var("HK_PKL_HTTP_REWRITE").ok());

pub static HK_PKL_CA_CERTIFICATES: LazyLock<Option<PathBuf>> =
    LazyLock::new(|| var_path("HK_PKL_CA_CERTIFICATES"));

/// Set to "pklr" to use the built-in pklr evaluator instead of the pkl CLI.
pub static HK_PKL_BACKEND: LazyLock<Option<String>> = LazyLock::new(|| var("HK_PKL_BACKEND").ok());

/// System's ARG_MAX value, memoized for performance
pub static ARG_MAX: LazyLock<usize> = LazyLock::new(|| {
    #[cfg(unix)]
    {
        // Try to get the system's ARG_MAX using sysconf
        // sysconf returns -1 on error or if the value is indeterminate
        unsafe {
            let value = libc::sysconf(libc::_SC_ARG_MAX);
            // Must check for -1 before casting to usize, as -1 would become a very large number
            if value != -1 && value > 0 {
                return value as usize;
            }
        }
    }

    // Fallback: Use a conservative 128KB limit that works on most systems
    // This is much smaller than typical ARG_MAX values (often 256KB-2MB)
    // but safe for portability
    128 * 1024
});

fn var_path(name: &str) -> Option<PathBuf> {
    var(name).map(PathBuf::from).ok()
}

fn var_csv(name: &str) -> Option<IndexSet<String>> {
    var(name)
        .map(|val| val.split(',').map(|s| s.trim().to_string()).collect())
        .ok()
}

fn var_log_level(name: &str) -> Option<log::LevelFilter> {
    var(name).ok().and_then(|level| level.parse().ok())
}

fn var_true(name: &str) -> bool {
    var(name)
        .map(|val| val.to_lowercase())
        .map(|val| val == "true" || val == "1")
        .unwrap_or(false)
}

fn var_false(name: &str) -> bool {
    var(name)
        .map(|val| val.to_lowercase())
        .map(|val| val == "false" || val == "0")
        .unwrap_or(false)
}

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

    #[test]
    fn test_arg_max_is_valid() {
        // ARG_MAX should be a reasonable value, not extremely large
        let arg_max = *ARG_MAX;

        // Should be at least the fallback value
        assert!(arg_max >= 128 * 1024, "ARG_MAX too small: {}", arg_max);

        // Should not be an unreasonably large value (like -1 cast to usize)
        // On most systems, ARG_MAX is between 128KB and 2MB
        // We'll use 10MB as an upper bound to catch the -1 bug
        assert!(
            arg_max <= 10 * 1024 * 1024,
            "ARG_MAX suspiciously large (possible -1 cast): {}",
            arg_max
        );
    }

    #[test]
    #[cfg(unix)]
    fn test_arg_max_unix_sysconf() {
        // On Unix systems, verify that sysconf returns a valid value or we use the fallback
        unsafe {
            let value = libc::sysconf(libc::_SC_ARG_MAX);
            if value == -1 {
                // If sysconf fails, we should use the fallback
                assert_eq!(*ARG_MAX, 128 * 1024);
            } else {
                // If sysconf succeeds, ARG_MAX should match it
                assert_eq!(*ARG_MAX, value as usize);
            }
        }
    }
}