prek 0.4.14

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

use std::ffi::OsString;
use std::path::{Path, PathBuf};
use std::sync::Arc;

use anyhow::{Context, Result};
use prek_consts::env_vars::EnvVars;
use prek_consts::prepend_paths;
use tracing::debug;

use crate::cli::reporter::HookInstallReporter;
use crate::hook::{Hook, InstallInfo, InstalledHook};
use crate::languages::{ExecutionEnvironment, LanguageBackend};
use crate::process::Cmd;
use crate::store::Store;

#[derive(Debug, Copy, Clone)]
pub(crate) struct Perl;

#[async_trait::async_trait(?Send)]
impl LanguageBackend for Perl {
    async fn install(
        &self,
        store: &Store,
        hook: Arc<Hook>,
        reporter: &HookInstallReporter,
    ) -> Result<InstalledHook> {
        let progress = reporter.on_install_start(&hook);

        let mut info = InstallInfo::new(&hook, &store.hooks_dir())?;

        debug!(%hook, target = %info.env_path.display(), "Installing Perl environment");

        let cpan = which::which("cpan").context(
            "Failed to locate cpan executable. Is cpan installed and available in PATH?",
        )?;

        if let Some(repo_path) = hook.repo_path() {
            Cmd::new(&cpan)
                .current_dir(repo_path)
                .arg("-T")
                .arg(".")
                .args(&hook.additional_dependencies)
                .envs(perl_env(&info.env_path)?)
                .check(true)
                .output()
                .await
                .context("Failed to install Perl dependencies")?;
        } else if !hook.additional_dependencies.is_empty() {
            Cmd::new(&cpan)
                .arg("-T")
                .args(&hook.additional_dependencies)
                .envs(perl_env(&info.env_path)?)
                .check(true)
                .output()
                .await
                .context("Failed to install Perl dependencies")?;
        }

        info.persist_env_path();

        reporter.on_install_complete(progress);

        Ok(InstalledHook::Installed {
            hook,
            info: Arc::new(info),
        })
    }

    async fn check_health(&self, _info: &InstallInfo) -> Result<()> {
        Ok(())
    }

    fn execution_environment(
        &self,
        _store: &Store,
        hook: &InstalledHook,
    ) -> Result<ExecutionEnvironment> {
        let env_dir = hook.env_path().expect("Perl must have env path");
        let new_path = prepend_paths(&[&bin_dir(env_dir)]).context("Failed to join PATH")?;

        let mut environment = ExecutionEnvironment::new();
        environment.set_path(&new_path).envs(perl_env(env_dir)?);
        Ok(environment)
    }
}

fn bin_dir(env_path: &Path) -> PathBuf {
    env_path.join("bin")
}

fn perl_env(env_path: &Path) -> Result<[(&'static str, OsString); 3]> {
    let env_path_str = env_path.to_string_lossy();
    let quoted_env_path = shlex::try_quote(&env_path_str)
        .context("Failed to quote Perl environment path")?
        .into_owned();

    Ok([
        (
            // PERL5LIB makes Perl load modules installed into this hook env at runtime.
            EnvVars::PERL5LIB,
            env_path.join("lib").join("perl5").into_os_string(),
        ),
        (
            // PERL_MB_OPT is consumed by Module::Build installers to install into this hook env.
            EnvVars::PERL_MB_OPT,
            format!("--install_base {quoted_env_path}").into(),
        ),
        (
            // PERL_MM_OPT is consumed by ExtUtils::MakeMaker installers to install into this hook env.
            EnvVars::PERL_MM_OPT,
            format!(
                "INSTALL_BASE={quoted_env_path} INSTALLSITEMAN1DIR=none INSTALLSITEMAN3DIR=none"
            )
            .into(),
        ),
    ])
}