_git 7.29 KB
Newer Older
Felipe Contreras's avatar
Felipe Contreras committed
1
2
3
4
#compdef git gitk

# zsh completion wrapper for git
#
5
# Copyright (c) 2012-2020 Felipe Contreras <felipe.contreras@gmail.com>
Felipe Contreras's avatar
Felipe Contreras committed
6
#
7
8
# The recommended way to install this script is to make a copy of it as a
# file named '_git' inside any directory in your fpath.
9
#
10
11
# For example, create a directory '~/.zsh/', copy this file to '~/.zsh/_git',
# and then add the following to your ~/.zshrc file:
Felipe Contreras's avatar
Felipe Contreras committed
12
#
13
#  fpath=(~/.zsh $fpath)
Felipe Contreras's avatar
Felipe Contreras committed
14
#
15
16
17
18
19
20
21
# You need git's bash completion script installed. By default bash-completion's
# location will be used (e.g. pkg-config --variable=completionsdir bash-completion).
#
# If your bash completion script is somewhere else, you can specify the
# location in your ~/.zshrc:
#
#  zstyle ':completion:*:*:git:*' script ~/.git-completion.bash
Felipe Contreras's avatar
Felipe Contreras committed
22
23
#

24
25
26
zstyle -T ':completion:*:*:git:*' tag-order && \
	zstyle ':completion:*:*:git:*' tag-order 'common-commands'

Felipe Contreras's avatar
Felipe Contreras committed
27
zstyle -s ":completion:*:*:git:*" script script
28
29
if [ -z "$script" ]; then
	local -a locations
30
31
32
33
34
	local e bash_completion

	bash_completion=$(pkg-config --variable=completionsdir bash-completion 2>/dev/null) ||
		bash_completion='/usr/share/bash-completion/completions/'

35
	locations=(
36
37
		"$(dirname ${funcsourcetrace[1]%:*})"/git-completion.bash
		"$HOME/.local/share/bash-completion/completions/git"
38
		"$bash_completion/git"
39
		'/etc/bash_completion.d/git' # old debian
40
41
42
43
44
		)
	for e in $locations; do
		test -f $e && script="$e" && break
	done
fi
45
46
47

local old_complete="$functions[complete]"
functions[complete]=:
48
COMP_WORDBREAKS=':'
49
GIT_SOURCING_ZSH_COMPLETION=y . "$script"
50
functions[complete]="$old_complete"
Felipe Contreras's avatar
Felipe Contreras committed
51

52
53
54
55
56
__gitcompadd ()
{
	compadd -Q -p "${2-}" -S "${3- }" ${@[4,-1]} -- ${=1} && _ret=0
}

Felipe Contreras's avatar
Felipe Contreras committed
57
58
59
60
61
62
__gitcomp ()
{
	emulate -L zsh

	local cur_="${3-$cur}"

63
	[[ "$cur_" == *= ]] && return
Felipe Contreras's avatar
Felipe Contreras committed
64

65
66
67
68
69
70
71
	local c IFS=$' \t\n' sfx
	for c in ${=1}; do
		if [[ $c == "--" ]]; then
			[[ "$cur_" == --no-* ]] && continue
			__gitcompadd "--no-..."
			break
		fi
72

73
74
75
76
77
78
79
80
81
82
83
		if [[ -z "${4-}" ]]; then
			case $c in
			*=) c="${c%=}"; sfx="=" ;;
			*.) sfx="" ;;
			*) sfx=" " ;;
			esac
		else
			sfx="$4"
		fi
		__gitcompadd "$c" "${2-}" "$sfx" -q
	done
84
85
}

Felipe Contreras's avatar
Felipe Contreras committed
86
87
88
89
__gitcomp_nl ()
{
	emulate -L zsh

90
	IFS=$'\n' __gitcompadd "$1" "${2-}" "${4- }"
Felipe Contreras's avatar
Felipe Contreras committed
91
92
}

93
__gitcomp_file ()
94
95
96
{
	emulate -L zsh

97
	compadd -f -p "${2-}" -- ${(f)1} && _ret=0
98
99
}

100
__gitcomp_direct ()
101
{
102
103
104
105
106
107
	__gitcomp_nl "$1" "" "" ""
}

__gitcomp_file_direct ()
{
	__gitcomp_file "$1" ""
108
109
}

110
__gitcomp_nl_append ()
111
{
112
113
	__gitcomp_nl "$@"
}
114

115
__gitcomp_direct_append ()
116
{
117
	__gitcomp_direct "$@"
118
119
120
121
}

_git_zsh ()
{
122
	__gitcomp "v1.2"
123
124
125
126
127
128
}

__git_complete_command ()
{
	emulate -L zsh

129
130
	compset -P '*[=:]'

131
132
133
134
135
	local command="$1"
	local completion_func="_git_${command//-/_}"
	if (( $+functions[$completion_func] )); then
		emulate ksh -c $completion_func
		return 0
136
137
138
	elif emulate ksh -c "__git_support_parseopt_helper $command"; then
		emulate ksh -c "__git_complete_common $command"
		return 0
139
140
141
	else
		return 1
	fi
142
143
}

144
145
146
147
148
149
__git_zsh_bash_func ()
{
	emulate -L ksh

	local command=$1

150
	__git_complete_command "$command" && return
151
152
153

	local expansion=$(__git_aliased_command "$command")
	if [ -n "$expansion" ]; then
154
		words[1]=$expansion
155
		__git_complete_command "$expansion"
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
	fi
}

__git_zsh_cmd_common ()
{
	local -a list
	list=(
	add:'add file contents to the index'
	bisect:'find by binary search the change that introduced a bug'
	branch:'list, create, or delete branches'
	checkout:'checkout a branch or paths to the working tree'
	clone:'clone a repository into a new directory'
	commit:'record changes to the repository'
	diff:'show changes between commits, commit and working tree, etc'
	fetch:'download objects and refs from another repository'
	grep:'print lines matching a pattern'
	init:'create an empty Git repository or reinitialize an existing one'
	log:'show commit logs'
	merge:'join two or more development histories together'
	mv:'move or rename a file, a directory, or a symlink'
	pull:'fetch from and merge with another repository or a local branch'
	push:'update remote refs along with associated objects'
	rebase:'forward-port local commits to the updated upstream head'
	reset:'reset current HEAD to the specified state'
180
	restore:'restore working tree files'
181
182
183
	rm:'remove files from the working tree and from the index'
	show:'show various types of objects'
	status:'show the working tree status'
184
	switch:'switch branches'
185
186
187
188
189
190
191
	tag:'create, list, delete or verify a tag object signed with GPG')
	_describe -t common-commands 'common commands' list && _ret=0
}

__git_zsh_cmd_alias ()
{
	local -a list
192
193
194
	list=(${${(0)"$(git config -z --get-regexp '^alias\.*')"}#alias.})
	list=(${(f)"$(printf "%s:alias for '%s'\n" ${(f@)list})"})
	_describe -t alias-commands 'aliases' list && _ret=0
195
196
197
198
199
200
201
202
203
204
205
206
207
208
}

__git_zsh_cmd_all ()
{
	local -a list
	emulate ksh -c __git_compute_all_commands
	list=( ${=__git_all_commands} )
	_describe -t all-commands 'all commands' list && _ret=0
}

__git_zsh_main ()
{
	local curcontext="$curcontext" state state_descr line
	typeset -A opt_args
209
	local -a orig_words __git_C_args
210
211
212
213

	orig_words=( ${words[@]} )

	_arguments -C \
214
215
216
217
		'(-p --paginate -P --no-pager)'{-p,--paginate}'[pipe all output into ''less'']' \
		'(-p --paginate -P --no-pager)'{-P,--no-pager}'[do not pipe git output into a pager]' \
		'(--bare)--git-dir=[set the path to the repository]: :_directories' \
		'(--git-dir)--bare[treat the repository as a bare repository]' \
218
		'(- :)--version[prints the git suite version]' \
219
220
221
222
223
224
225
		'--exec-path=[path to where your core git programs are installed]: :_directories' \
		'(- :)--exec-path[print the path where your core git programs are installed]' \
		'(- :)--html-path[print the path where git''s HTML documentation is installed]' \
		'(- :)--info-path[print the path where the Info files are installed]' \
		'(- :)--man-path[print the manpath (see `man(1)`) for the man pages]' \
		'--work-tree=[set the path to the working tree]: :_directories' \
		'--namespace=[set the git namespace]:' \
226
227
		'--no-replace-objects[do not use replacement refs to replace git objects]' \
		'(- :)--help[prints the synopsis and a list of the most commonly used commands]: :->arg' \
228
229
		'*-C[run as if git was started in the given path]: :_directories' \
		'*-c[pass a configuration parameter to the command]: :->config' \
230
231
232
233
234
		'(-): :->command' \
		'(-)*:: :->arg' && return

	case $state in
	(command)
235
236
237
238
239
240
241
		_tags common-commands alias-commands all-commands
		while _tags; do
			_requested common-commands && __git_zsh_cmd_common
			_requested alias-commands && __git_zsh_cmd_alias
			_requested all-commands && __git_zsh_cmd_all
			let _ret || break
		done
242
		;;
243
244
245
246
	(config)
		compset -P '*[=:]'
		emulate ksh -c __git_complete_config_variable_name_and_value
		;;
247
248
249
250
251
252
	(arg)
		local command="${words[1]}" __git_dir

		if (( $+opt_args[--bare] )); then
			__git_dir='.'
		else
253
			__git_dir=${~opt_args[--git-dir]}
254
255
		fi

256
257
258
259
		for x in ${(s.:.)opt_args[-C]}; do
			__git_C_args+=('-C' ${~x})
		done

260
261
262
263
264
265
266
267
268
		(( $+opt_args[--help] )) && command='help'

		words=( ${orig_words[@]} )

		__git_zsh_bash_func $command
		;;
	esac
}

Felipe Contreras's avatar
Felipe Contreras committed
269
270
271
_git ()
{
	local _ret=1
272
273
274
275
276
277
278
279
	local cur cword prev

	cur=${words[CURRENT]}
	prev=${words[CURRENT-1]}
	let cword=CURRENT-1

	if (( $+functions[__${service}_zsh_main] )); then
		__${service}_zsh_main
280
	elif (( $+functions[__${service}_main] )); then
281
		emulate ksh -c __${service}_main
282
283
	elif (( $+functions[_${service}] )); then
		emulate ksh -c _${service}
284
285
	elif ((	$+functions[_${service//-/_}] )); then
		emulate ksh -c _${service//-/_}
286
287
288
	fi

	let _ret && _default && _ret=0
Felipe Contreras's avatar
Felipe Contreras committed
289
290
291
292
	return _ret
}

_git