mise 2026.9.14

use crate::file::display_path;

use crate::config::Settings;
use crate::file;
use crate::git::Git;

/// Generate a git pre-commit hook
///
/// This command generates a git pre-commit hook that runs a mise task like `mise run pre-commit`
/// when you commit changes to your repository.
///
/// Staged files are passed to the task as `STAGED`.
///
/// Hooks that git hands a message file — `commit-msg`, `prepare-commit-msg`,
/// `applypatch-msg` and `sendemail-validate` — pass that file to the task. git's other
/// arguments are not forwarded, so a `pre-push` hook's remote name and URL are not
/// appended to the task's command.
///
/// For more advanced pre-commit functionality, see mise's sister project: https://hk.jdx.dev/
#[derive(Debug, usage_rs::Args)]
#[usage(
    verbatim_doc_comment,
    visible_alias = "pre-commit",
    example(
        r###"mise generate git-pre-commit --write --task=pre-commit
git commit -m "feat: add new feature""###,
        help = "Install the hook; committing then runs `mise run pre-commit`."
    ),
    example(
        r###"mise generate git-pre-commit --write -- -C subdir"###,
        help = r###"config lives in a subdirectory, so the hook has to change into it first"###
    )
)]
pub(super) struct GitPreCommit {
    /// The task to run when the pre-commit hook is triggered
    #[usage(long, short, default = "pre-commit")]
    task: String,
    /// Write to .git/hooks/pre-commit and make it executable
    #[usage(long, short)]
    write: bool,
    /// Which hook to generate (saves to .git/hooks/$hook)
    #[usage(long, default = "pre-commit")]
    hook: String,
    /// mise flags to embed in the generated hook, given after `--`
    ///
    /// These are inserted between `mise` and `run`, so the hook carries the same context you
    /// would pass on the command line. Useful when the config is not at the repository root,
    /// since git runs hooks from the top level: `-- -C subdir` makes the hook find it.
    #[usage(
        double_dash = "required",
        value_name = "MISE_ARG",
        verbatim_doc_comment
    )]
    mise_args: Vec<String>,
}

/// Hooks git calls with the path to a message file, as their first argument, for the
/// hook to read or edit.
const FILE_ARG_HOOKS: &[&str] = &[
    "applypatch-msg",
    "commit-msg",
    "prepare-commit-msg",
    "sendemail-validate",
];

impl GitPreCommit {
    pub(super) async fn run(self) -> eyre::Result<()> {
        let output = self.generate();
        if self.write {
            let quiet = Settings::get().quiet;
            let path = Git::get_path("hooks")?.join(&self.hook);
            if path.exists() {
                let old_path = path.with_extension("old");
                if !quiet {
                    miseprintln!(
                        "Moving existing hook to {:?}",
                        old_path.file_name().unwrap()
                    );
                }
                file::rename(&path, path.with_extension("old"))?;
            }
            file::write(&path, &output)?;
            file::make_executable(&path)?;
            if !quiet {
                miseprintln!("Wrote to {}", display_path(&path));
            }
        } else {
            miseprintln!("{output}");
        }
        Ok(())
    }

    fn generate(&self) -> String {
        let task = &self.task;
        // Quoted rather than joined with spaces so an argument that contains one — a
        // `-C` pointing at a directory with a space, say — survives as a single word.
        let mise_args = if self.mise_args.is_empty() {
            String::new()
        } else {
            format!(" {}", shell_words::join(&self.mise_args))
        };
        // A task that declares no args gets extra arguments appended to its last command,
        // so forwarding git's arguments is only safe when the task is meant to read them.
        // For the message hooks the file is the whole point; anything else (`pre-push`'s
        // remote name and URL, `prepare-commit-msg`'s source and SHA) would land on
        // commands such as `npm test` that never asked for it (discussion #13366).
        let hook_args = if FILE_ARG_HOOKS.contains(&self.hook.as_str()) {
            r#" "$1""#
        } else {
            ""
        };
        format!(
            r#"#!/bin/sh
STAGED="$(git diff-index --cached --name-only -z HEAD | xargs -0)"
export STAGED
export MISE_PRE_COMMIT=1
exec mise{mise_args} run {task}{hook_args}
"#
        )
    }
}

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

    fn generate(task: &str, hook: &str) -> String {
        generate_with_args(task, hook, &[])
    }

    fn generate_with_args(task: &str, hook: &str, mise_args: &[&str]) -> String {
        GitPreCommit {
            task: task.to_string(),
            write: false,
            hook: hook.to_string(),
            mise_args: mise_args.iter().map(|s| s.to_string()).collect(),
        }
        .generate()
    }

    #[test]
    fn forwards_hook_arguments_to_the_task() {
        // Without the passthrough a `commit-msg` hook cannot reach the message file git
        // hands it, which is the whole point of that hook.
        let out = generate("lint-commit-msg", "commit-msg");
        assert!(
            out.ends_with("exec mise run lint-commit-msg \"$1\"\n"),
            "the message file must reach the task:\n{out}"
        );
    }

    /// `prepare-commit-msg` also gets the message source and sometimes a SHA; only the file
    /// is meant for the task, and the rest would be appended to its last command.
    #[test]
    fn prepare_commit_msg_forwards_only_the_message_file() {
        let out = generate("prep", "prepare-commit-msg");
        assert!(out.ends_with("exec mise run prep \"$1\"\n"), "{out}");
    }

    /// git calls `pre-push` with the remote name and URL. A task without declared args
    /// would get them appended to its last command, so they must not be forwarded
    /// (discussion #13366).
    #[test]
    fn pre_push_does_not_forward_hook_arguments() {
        let out = generate("pre-push", "pre-push");
        assert!(out.ends_with("exec mise run pre-push\n"), "{out}");
    }

    #[test]
    fn pre_commit_output_is_unchanged_in_substance() {
        let out = generate("pre-commit", "pre-commit");
        assert!(out.starts_with("#!/bin/sh\n"), "{out}");
        assert!(out.contains("export MISE_PRE_COMMIT=1"), "{out}");
        assert!(out.contains("STAGED="), "{out}");
    }

    /// Frozen copy of the hook as it was before the passthrough existed.
    const HOOK_WITHOUT_MISE_ARGS: &str = r#"#!/bin/sh
STAGED="$(git diff-index --cached --name-only -z HEAD | xargs -0)"
export STAGED
export MISE_PRE_COMMIT=1
exec mise run pre-commit
"#;

    /// Passing nothing must leave the hook byte-identical, so the ones already written
    /// stay valid. Compared whole rather than by substring: an extra or duplicated line
    /// would slip past a `contains` check.
    #[test]
    fn no_mise_args_leaves_the_hook_unchanged() {
        assert_eq!(generate("pre-commit", "pre-commit"), HOOK_WITHOUT_MISE_ARGS);
    }

    /// git runs hooks from the repository root, so a config kept in a subdirectory is only
    /// reachable if the hook carries the flag that gets mise there (discussion #4304).
    #[test]
    fn mise_args_are_inserted_before_run() {
        let out = generate_with_args("lint", "commit-msg", &["-C", "subdir", "-E", "ci"]);
        assert!(
            out.contains(r#"exec mise -C subdir -E ci run lint "$1""#),
            "{out}"
        );
    }

    /// What matters is that a shell reading the hook sees the same argument boundaries we
    /// were given — not which quoting style `shell_words::join` happened to pick. Splitting
    /// the line back apart asserts the property instead of the spelling.
    #[test]
    fn an_argument_containing_a_space_stays_one_word() {
        let out = generate_with_args("lint", "commit-msg", &["-C", "my dir"]);
        let exec_line = out
            .lines()
            .find(|line| line.starts_with("exec mise"))
            .expect("generated hook should exec mise");
        let words = shell_words::split(exec_line).expect("exec line should be valid shell");
        assert_eq!(words, ["exec", "mise", "-C", "my dir", "run", "lint", "$1"]);
    }

    /// The tests above build the struct directly, so they cannot see the question this
    /// feature actually turns on: `-C` and `-E` are global flags, and without `last = true`
    /// clap would bind them to `Cli` instead of handing them to the hook — leaving the
    /// generated script silently unchanged. Parse a real command line to pin that down.
    #[test]
    fn passthrough_args_reach_the_command_through_the_parser() {
        let argv = [
            "mise",
            "generate",
            "git-pre-commit",
            "--task",
            "lint",
            "--",
            "-C",
            "subdir",
            "-E",
            "ci",
        ];
        let argv: Vec<&std::ffi::OsStr> = argv.iter().map(std::ffi::OsStr::new).collect();
        let cli = crate::cli::Cli::parse_from_argv(&argv)
            .expect("the documented invocation should parse");
        assert!(cli.cd.is_none());
        assert!(cli.env.is_none());
        let Some(crate::cli::Commands::Generate(generate)) = cli.command else {
            panic!("generate should be the resolved subcommand");
        };
        let super::super::Commands::GitPreCommit(command) = generate.command else {
            panic!("git-pre-commit should be the resolved subcommand");
        };
        assert_eq!(command.task, "lint");
        assert_eq!(command.mise_args, ["-C", "subdir", "-E", "ci"]);
    }
}