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

//! Step configuration and execution.
//!
//! This module provides the core step functionality for hk. A step represents
//! a single linting or formatting task that operates on files.
//!
//! # Module Organization
//!
//! - [`types`] - Core type definitions (Step, Pattern, Script, RunType, OutputSummary)
//! - [`shell`] - Shell type detection and quoting utilities
//! - [`filtering`] - File filtering, binary/symlink detection, profile handling
//! - [`batching`] - ARG_MAX handling and job batching
//! - [`job_builder`] - Step job creation
//! - [`execution`] - Async job orchestration
//! - [`runner`] - Single job execution
//! - [`check_parsing`] - Parsing check_list_files and check_diff output
//! - [`diff`] - Applying unified diffs directly
//! - [`output`] - Output capture and fix suggestions
//! - [`progress`] - Progress bar management
//! - [`expr_env`] - Expression evaluation for conditions
//!
//! # Usage
//!
//! Steps are typically created from configuration (hk.pkl) and executed via hooks:
//!
//! ```ignore
//! // Steps are defined in hk.pkl
//! ["eslint"] {
//!     glob = "*.{js,ts}"
//!     check = "eslint {{files}}"
//!     fix = "eslint --fix {{files}}"
//! }
//! ```

mod batching;
mod check_parsing;
mod diff;
mod execution;
mod expr_env;
mod filtering;
mod job_builder;
mod output;
mod progress;
mod runner;
mod shell;
mod types;

// Re-export public API
pub use expr_env::{EXPR_CTX, EXPR_ENV};
pub use shell::ShellType;
pub use types::{OutputSummary, Pattern, RunType, Script, Step};

// Re-export for potential external use (currently only used internally)
#[allow(unused_imports)]
pub use filtering::{is_binary_file, is_symlink_file};

/// Strip ".orig" suffix from "---" lines when the next "+++" line doesn't have it.
/// Go tools like gofmt add ".orig" only to the "---" line.
pub(crate) fn strip_orig_suffix(diff: &str) -> String {
    let mut result: Vec<String> = Vec::new();
    let mut lines = diff.lines().peekable();
    while let Some(line) = lines.next() {
        if let Some(after_prefix) = line.strip_prefix("--- ")
            && let Some(next) = lines.peek()
            && next.starts_with("+++ ")
            && !next.contains(".orig")
        {
            // Extract path portion (before any tab-separated timestamp)
            let (path, rest) = after_prefix.split_once('\t').unwrap_or((after_prefix, ""));
            if let Some(stripped) = path.strip_suffix(".orig") {
                if rest.is_empty() {
                    result.push(format!("--- {stripped}"));
                } else {
                    result.push(format!("--- {stripped}\t{rest}"));
                }
                continue;
            }
        }
        result.push(line.to_string());
    }
    result.join("\n") + "\n"
}