prek 0.3.11

A fast Git hook manager written in Rust, designed as a drop-in alternative to pre-commit, reimagined.
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

use std::path::Path;

use anyhow::Result;
use tracing::debug;

use crate::hook::Hook;

mod check_added_large_files;
mod check_case_conflict;
mod check_executables_have_shebangs;
pub(crate) mod check_json;
mod check_merge_conflict;
mod check_shebang_scripts_are_executable;
mod check_symlinks;
mod check_toml;
mod check_vcs_permalinks;
mod check_xml;
mod check_yaml;
mod destroyed_symlinks;
mod detect_private_key;
mod file_contents_sorter;
mod fix_byte_order_marker;
mod fix_end_of_file;
mod fix_trailing_whitespace;
mod forbid_new_submodules;
mod mixed_line_ending;
mod no_commit_to_branch;
mod pretty_format_json;
mod shebangs;

pub(crate) use check_added_large_files::check_added_large_files;
pub(crate) use check_case_conflict::check_case_conflict;
pub(crate) use check_executables_have_shebangs::check_executables_have_shebangs;
pub(crate) use check_json::check_json;
pub(crate) use check_merge_conflict::check_merge_conflict;
pub(crate) use check_shebang_scripts_are_executable::check_shebang_scripts_are_executable;
pub(crate) use check_symlinks::check_symlinks;
pub(crate) use check_toml::check_toml;
pub(crate) use check_vcs_permalinks::check_vcs_permalinks;
pub(crate) use check_xml::check_xml;
pub(crate) use check_yaml::check_yaml;
pub(crate) use destroyed_symlinks::destroyed_symlinks;
pub(crate) use detect_private_key::detect_private_key;
pub(crate) use file_contents_sorter::file_contents_sorter;
pub(crate) use fix_byte_order_marker::fix_byte_order_marker;
pub(crate) use fix_end_of_file::fix_end_of_file;
pub(crate) use fix_trailing_whitespace::fix_trailing_whitespace;
pub(crate) use forbid_new_submodules::forbid_new_submodules;
pub(crate) use mixed_line_ending::mixed_line_ending;
pub(crate) use no_commit_to_branch::no_commit_to_branch;
pub(crate) use pretty_format_json::pretty_format_json;

/// Hooks from `https://github.com/pre-commit/pre-commit-hooks`.
#[derive(strum::EnumString)]
#[strum(serialize_all = "kebab-case")]
pub(crate) enum PreCommitHooks {
    CheckAddedLargeFiles,
    CheckCaseConflict,
    CheckExecutablesHaveShebangs,
    CheckShebangScriptsAreExecutable,
    CheckVcsPermalinks,
    FileContentsSorter,
    EndOfFileFixer,
    FixByteOrderMarker,
    ForbidNewSubmodules,
    CheckJson,
    CheckSymlinks,
    CheckMergeConflict,
    CheckToml,
    CheckXml,
    CheckYaml,
    DestroyedSymlinks,
    MixedLineEnding,
    DetectPrivateKey,
    NoCommitToBranch,
    // `pretty-format-json` is intentionally builtin-only for now. Do not enable
    // automatic fast-path replacement until parity coverage against upstream
    // Python is broad enough to trust it as the default implementation.
    // PrettyFormatJson,
    TrailingWhitespace,
}

impl PreCommitHooks {
    pub(crate) fn check_supported(&self, hook: &Hook) -> bool {
        match self {
            // `check-yaml` does not support `--unsafe` flag yet.
            Self::CheckYaml => !hook.args.iter().any(|s| s.starts_with("--unsafe")),
            _ => true,
        }
    }

    pub(crate) async fn run(self, hook: &Hook, filenames: &[&Path]) -> Result<(i32, Vec<u8>)> {
        debug!("Running hook `{}` in fast path", hook.id);
        match self {
            Self::CheckAddedLargeFiles => check_added_large_files(hook, filenames).await,
            Self::CheckCaseConflict => check_case_conflict(hook, filenames).await,
            Self::CheckExecutablesHaveShebangs => {
                check_executables_have_shebangs(hook, filenames).await
            }
            Self::CheckShebangScriptsAreExecutable => {
                check_shebang_scripts_are_executable(hook, filenames).await
            }
            Self::CheckVcsPermalinks => check_vcs_permalinks(hook, filenames).await,
            Self::FileContentsSorter => file_contents_sorter(hook, filenames).await,
            Self::EndOfFileFixer => fix_end_of_file(hook, filenames).await,
            Self::FixByteOrderMarker => fix_byte_order_marker(hook, filenames).await,
            Self::ForbidNewSubmodules => forbid_new_submodules(hook, filenames).await,
            Self::CheckJson => check_json(hook, filenames).await,
            Self::CheckSymlinks => check_symlinks(hook, filenames).await,
            Self::CheckMergeConflict => check_merge_conflict(hook, filenames).await,
            Self::CheckToml => check_toml(hook, filenames).await,
            Self::CheckYaml => check_yaml(hook, filenames).await,
            Self::CheckXml => check_xml(hook, filenames).await,
            Self::DestroyedSymlinks => destroyed_symlinks(hook, filenames).await,
            Self::MixedLineEnding => mixed_line_ending(hook, filenames).await,
            Self::DetectPrivateKey => detect_private_key(hook, filenames).await,
            Self::NoCommitToBranch => no_commit_to_branch(hook).await,
            Self::TrailingWhitespace => fix_trailing_whitespace(hook, filenames).await,
        }
    }
}

// TODO: compare rev
pub(crate) fn is_pre_commit_hooks(url: &str) -> bool {
    url == "https://github.com/pre-commit/pre-commit-hooks"
}