A clink script for supporting tab-completion of git branches when using "git checkout"

git_checkout.lua

-- Ctrl-Q in conemu to reload Clink Lua scripts
-- Clink match generators: https://github.com/mridgers/clink/blob/master/docs/clink.md#user-content-match-generators
-- Strings: http://lua-users.org/wiki/StringLibraryTutorial
-- Patterns: http://lua-users.org/wiki/PatternsTutorial
-- Escaping: http://www.lua.org/pil/20.2.html
-- local: http://www.lua.org/pil/4.2.html

-- git commands which will autocomplete branch names after them:
local git_commands = {"checkout", "co", "merge", "branch -d", "branch -D"}

function git_checkout_match_generator(text, first, last)
	local commandLine = rl_state.line_buffer
	--print("git_checkout_match_generator", text, first, last, "commandLine:", commandLine)--debug

	-- match "git rebase" parameters
	if commandLine:find("git rebase ", 1, true) == 1 then
		local matchedRebaseParam = false
		for _,rebaseParam in pairs({"--continue", "--skip", "--abort"}) do
			if rebaseParam:find(text, 1, true) then
				clink.add_match(rebaseParam)
				matchedRebaseParam = true
			end
		end
		if matchedRebaseParam then
			return true
		end
	end

	local matchedCommand = false
	
	for _,command in pairs(git_commands) do
		local commandFirst, commandLast = commandLine:find("git " .. command .. " ", 1, true) -- use plain-text find, so I don't have to escape "-" in the list of commands above
		if commandFirst == 1 then -- the command must start at the beginning of the line (and I couldn't just use ^ in the pattern, since I used plain-text find)
			matchedCommand = true
			break
		end
	end
	
	local matchedBranches = false
	
	if matchedCommand then
		local gitBranchParam = ""
		if(text:find("/")) then
			-- search all branches when a slash is included (so I can autocomplete remotes, and then remove the "origin/" to check them out)
			gitBranchParam = "-a"
		end
		for line in io.popen("git branch " .. gitBranchParam .. " 2>nul"):lines() do
			local branch = line:match("[%* ] (.+)$")
			if branch then
				if branch:find(text, 1, true) then -- use plain-text find, so "-" in branch names will not break stuff. -- If they entered nothing to match, text will be blank, and all branches will match it.
					matchedBranches = true
					clink.add_match(branch)
				end
			end
		end
	end
	
	return matchedBranches
end

clink.register_match_generator(git_checkout_match_generator, 10)

Thanks for this! I made these changes to lines 41 to 56:

if matchedCommand then
	for line in io.popen("git branch -a 2>nul"):lines() do
		local branch = line:match("[%* ] (.+)$")
		if not branch:find("HEAD", 1, true) then
			branch = string.gsub(branch, "remotes/origin/", "")
			if branch:find(text, 1, true) then
				matchedBranches = true
				clink.add_match(branch)
			end
		end
	end
end

What this does is

• Always runs a git branch -a to get remote branches
• Removes the remote branch HEAD from appearing
• Replaces remotes/origin/ with nothing so only the branch name appears

Now remote and local branches will always be populated without remotes/origin/

Where it has to be saved this file?

Where it has to be saved this file?

On my machine it goes in C:\Program Files (x86)\clink\0.4.9.

where can i find extra documentation about clink api?

I don't know of any current documentation. Here is some old stuff which has been deleted: https://github.com/mridgers/clink/blob/298113a61272afa3f646a912c97e2ce34da67597/docs/clink.md#match-generators

I don't know of any current documentation. Here is some old stuff which has been deleted: https://github.com/mridgers/clink/blob/298113a61272afa3f646a912c97e2ce34da67597/docs/clink.md#match-generators

thanks u

I'm currently trying out this much fancier git autocompletion script: https://github.com/vladimir-kotikov/clink-completions/blob/master/git.lua

@bhank If you don't like that one - there is a lighter one at https://github.com/ztomm/git-autocomplete-for-windows