gitsnitch 0.4.5

Lints your Git commit history against a declarative ruleset
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

use std::ffi::OsStr;

use super::{AppError, Args, DEFAULT_ENV_PREFIX};

pub(crate) fn validate_custom_meta(entries: &[String]) -> Result<(), AppError> {
    for entry in entries {
        let Some((key, value)) = entry.split_once('=') else {
            return Err(AppError::Message(format!(
                "invalid --custom-meta entry '{entry}': expected key=value"
            )));
        };

        if key.trim().is_empty() {
            return Err(AppError::Message(format!(
                "invalid --custom-meta entry '{entry}': key cannot be empty"
            )));
        }

        if value.trim().is_empty() {
            return Err(AppError::Message(format!(
                "invalid --custom-meta entry '{entry}': value cannot be empty"
            )));
        }
    }

    Ok(())
}

pub(crate) fn validate_env_resolution_mode(args: &Args) -> Result<(), AppError> {
    if !args.remap_env_var.is_empty() && args.env_prefix != DEFAULT_ENV_PREFIX {
        return Err(AppError::Message(
            "--remap-env-var is mutually exclusive with non-default --env-prefix; use default GITSNITCH_ prefix when remapping"
                .to_owned(),
        ));
    }

    Ok(())
}

pub(crate) fn validate_gitsnitch_json_path(args: &Args) -> Result<(), AppError> {
    let Some(path) = &args.gitsnitch_json else {
        return Ok(());
    };

    if path.as_os_str() == OsStr::new("-") {
        return Err(AppError::Message(
            "--gitsnitch-json does not accept '-' ; provide a real file path".to_owned(),
        ));
    }

    Ok(())
}

pub(crate) fn validate_staged_commit_mode(args: &Args) -> Result<(), AppError> {
    let staged_requested = args.validate_staged_commit || args.commit_msg_file.is_some();

    if args.commit_msg_source.is_some() && !staged_requested {
        return Err(AppError::Message(
            "--commit-msg-source requires --validate-staged-commit or --commit-msg-file".to_owned(),
        ));
    }

    Ok(())
}

pub(crate) fn validate_commit_msg_file_path(args: &Args) -> Result<(), AppError> {
    let Some(path) = &args.commit_msg_file else {
        return Ok(());
    };

    if path.as_os_str() == OsStr::new("-") {
        return Err(AppError::Message(
            "--commit-msg-file does not accept '-' ; provide a real file path".to_owned(),
        ));
    }

    if !path.exists() {
        return Err(AppError::Message(format!(
            "--commit-msg-file '{}' does not exist",
            path.display()
        )));
    }

    Ok(())
}