Add option to show git diff before commit

[qianlongzt]

Is your feature request related to a problem? Please describe.

I use git.autoPush to avoid forgetting to push configuration changes.
I want to know what changes were made before writing the commit message.

vim ~/.config/xxx
chezmoi add ~/.config/xxx

Describe the solution you'd like

add new option git.showDiff(or else) to show git diff --cached before commit

Describe alternatives you've considered

1. chezmoi diff shows changes in the opposite direction.
2. chezmoi cd requires temporarily disabling git.autoCommit and git.autoPush.
3. commitMessageTemplate = "{{output \"git\" \"diff\" \"--color=always\" \"--cached\" | promptString }}"
   1. Sometimes I get the error on windows git no option --cached
   2. chezmoi: template: git.commitMessageTemplate:1:2: executing "git.commitMessageTemplate" at <output "git" "diff" "--color=always" "--cached">: error calling output: 'D:\\scoop\\local\\shims\\git.exe' diff --color=always --cached: exit status 129

Additional context

[twpayne]

#4236 adds git-auto-commit and git-auto-push hooks. With this, you can add a hooks.git-auto-commit.pre hook that runs git diff -C $CHEZMOI_SOURCE_DIR before invoking your commit message template to prompt for the commit message. Would you be able to test this?

[qianlongzt]

Thanks for your work.
I tested it, but it runs the command in the home directory. Can we add an option to specify the working directory for the hook?

# ~/.config/chezmoi/chezmoi.toml.tmpl
[hooks.git-auto-commit.pre]
command = "git"
args = ["diff", "--cached", "--color=always"]

directory = {{.chezmoi.workingTree}}

[git]
autoCommit=true
autoPush=true

chezmoi/internal/cmd/config.go

Line 2560 in 500c677

return c.run(c.homeDirAbsPath, name, args)

[twpayne]

You can use the -C option to git to change the directory that git runs in.

[qianlongzt]

Thanks for the reply again. I missed the -C option in the first reply.

Now, it's asking for a commit message before running the git-auto-commit.pre hook. Can we prompt for the commit message after the pre-hook?

chezmoi/internal/cmd/config.go

Lines 1582 to 1593 in 3fdaa59

	commitMessage, err := c.gitCommitMessage(cmd, status)
	if err != nil {
	return err
	}
	if err := c.runHookPre("git-auto-commit"); err != nil {
	return err
	}
	if err := c.run(c.WorkingTreeAbsPath, c.Git.Command, []string{"commit", "--message", string(commitMessage)}); err != nil {
	return err
	}
	if err := c.runHookPost("git-auto-commit"); err != nil {
	return err

[halostatue]

I agree with this change, but this is better done by doing the following (well, in your dot_config/git/config.tmpl):

git config --global commit.verbose true

[qianlongzt]

Thank you @halostatue . commit.verbose is better choice. No, it not work with chezmoi, chezmoi ignore the commit.verbose

[halostatue]

I thought I had not posted this, because I realized that it won't work because this is auto-commit (something I don't use).

[qianlongzt]

Never mind, I learned git usage tips