[mini.git] Show short commit hash when in detached HEAD

[myzb]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.git

Question

Hi,

I'm currently cutting down on my plugins. Besides moving what I can to mini I'm also creating my own statusbar, which is basically the nvim default one but with extra git information.

From what it seems, mini.git will show HEAD for the branch information when in detached head. I'd like to instead show the short commit instead. I know I could just get the full commit hash from minigit_summary and trim it but using something like git rev-parse --short HEAD would give me a "dynamic" sized short hash. In the codebases I work having 10 chars for the hash was not too uncommon.

Do you have an idea how I can achieve this? I know gitsigns does this by default, but it would be great if I could do this with mini instead.

This is what I currently have and it half works. But doing a git checkout I get spammed by errors and I'd also like for Git rev-parse to not open the result in a new buffer.

vim.api.nvim_create_autocmd('User', {
	pattern = "MiniGitUpdated",
	callback = function(data)
		local summary = vim.b[data.buf].minigit_summary
		if summary.head_name == "HEAD" then
			vim.cmd([[Git rev-parse --short HEAD]])
		end
	end
})

vim.api.nvim_create_autocmd('User', {
	pattern = "MiniGitCommandDone",
	callback = function(data)
		-- react on `:Git rev-parse`
		if data.data.git_subcommand == "rev-parse" then
			vim.b[data.buf].minigit_summary_string = data.data.stdout
		end
	end,
})

PS: To the reason for preferring the git hash over HEAD, ... perhaps I convince you to make this a feature :))

I feel it gives me more information on where I am in my git tree. E.g if I'm backtracing commits for some faulty change and have my history open in a second window (github), I can map in my head what I see in the current buffer to the list I have open.
Also doing git checkout <hash/branch> and seeing the hash or branch name in the status line feels more consistent.

[echasnovski]

From what it seems, mini.git will show HEAD for the branch information when in detached head.

Yes, it is documented.

I know I could just get the full commit hash from minigit_summary and trim it but using something like git rev-parse --short HEAD would give me a "dynamic" sized short hash. In the codebases I work having 10 chars for the hash was not too uncommon.

Yes, explicitly trimming full commit hash is the suggested approach and it is what is done for minigit_summary_string. If you feel like 10 characters is needed, then always trimming to 10 characters doesn't seem like a big problem.

PS: To the reason for preferring the git hash over HEAD, ... perhaps I convince you to make this a feature :))

The main reason the HEAD is used to show detached head state is to be able to actually detect a detached HEAD state. If automatically replaced with commit hash, then there is no way to 100% detect the state (short commit hash can look very much like branch name).