standard-githooks 0.11.12

/// All git hook types managed by git-std, in recommended install order.
pub const KNOWN_HOOKS: &[&str] = &[
    "pre-commit",
    "commit-msg",
    "pre-push",
    "post-commit",
    "prepare-commit-msg",
    "post-merge",
];

/// Generate the shim script content for a given hook name.
///
/// The shim delegates execution to `git std hook run <hook> -- <args>`,
/// passing through any arguments git provides after `--` so that clap's
/// `#[arg(last = true)]` can capture them.
///
/// # Example
///
/// ```
/// use standard_githooks::generate_shim;
///
/// let shim = generate_shim("pre-commit");
/// assert!(shim.contains("exec git std hook run pre-commit"));
/// ```
pub fn generate_shim(hook_name: &str) -> String {
    format!(
        "#!/bin/bash\n\
         # Managed by git-std — do not edit.\n\
         # Configure commands in .githooks/{hook_name}.hooks\n\
         exec git std hook run {hook_name} -- \"$@\"\n"
    )
}

/// Generate the `.hooks` template file content for a given hook name.
///
/// Includes a full header comment explaining the prefix system with examples.
/// For `commit-msg`, adds a default validation command that is active out of
/// the box.
pub fn generate_hooks_template(hook_name: &str) -> String {
    let fix_line = if hook_name == "pre-commit" {
        "#   ~  fix       auto-format staged files and re-stage (pre-commit only)\n\
         #                uses a stash dance to safely isolate staged content\n"
    } else {
        ""
    };

    let default_commands = if hook_name == "commit-msg" {
        "! git std lint --file {msg}\n"
    } else {
        ""
    };

    format!(
        "# git-std hooks — {hook_name}.hooks\n\
         #\n\
         # Each line is a command run during the {hook_name} hook.\n\
         # Prefix controls behavior:\n\
         #\n\
         #   !  check     run command, block commit on failure\n\
         {fix_line}\
         #   ?  advisory  run command, never block commit\n\
         #\n\
         # $@ contains the list of staged files — commands can use or ignore it.\n\
         #\n\
         # Examples:\n\
         #   ! cargo fmt --check   # fail if code is unformatted\n\
         #   ! cargo clippy        # lint workspace\n\
         #   ? cargo test          # run tests, never block commit\n\
         #\n\
         # Enable/disable this hook:\n\
         #   git std hook enable {hook_name}\n\
         #   git std hook disable {hook_name}\n\
         #\n\
         {default_commands}"
    )
}

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

    #[test]
    fn shim_contains_exec_line() {
        let shim = generate_shim("pre-commit");
        assert!(shim.contains("exec git std hook run pre-commit -- \"$@\""));
    }

    #[test]
    fn shim_has_managed_comment() {
        let shim = generate_shim("commit-msg");
        assert!(shim.contains("Managed by git-std"));
        assert!(shim.contains(".githooks/commit-msg.hooks"));
    }

    #[test]
    fn hooks_template_has_header() {
        let t = generate_hooks_template("pre-commit");
        assert!(t.contains("pre-commit.hooks"));
        assert!(t.contains("!  check"));
        assert!(t.contains("~  fix"));
        assert!(t.contains("?  advisory"));
    }

    #[test]
    fn hooks_template_no_fix_line_for_non_precommit() {
        let t = generate_hooks_template("commit-msg");
        assert!(!t.contains("~  fix"));
    }

    #[test]
    fn commit_msg_template_has_default_check_command() {
        let t = generate_hooks_template("commit-msg");
        assert!(t.contains("! git std lint --file {msg}"));
    }

    #[test]
    fn non_commit_msg_template_has_no_default_commands() {
        let t = generate_hooks_template("pre-push");
        assert!(!t.contains("git std lint"));
    }

    #[test]
    fn known_hooks_contains_standard_hooks() {
        assert!(KNOWN_HOOKS.contains(&"pre-commit"));
        assert!(KNOWN_HOOKS.contains(&"commit-msg"));
        assert!(KNOWN_HOOKS.contains(&"pre-push"));
    }
}