3 # zsh completion wrapper for git
5 # Copyright (c) 2012-2020 Felipe Contreras <felipe.contreras@gmail.com>
7 # The recommended way to install this script is to make a copy of it as a
8 # file named '_git' inside any directory in your fpath.
10 # For example, create a directory '~/.zsh/', copy this file to '~/.zsh/_git',
11 # and then add the following to your ~/.zshrc file:
13 # fpath=(~/.zsh $fpath)
15 # You need git's bash completion script installed. By default bash-completion's
16 # location will be used (e.g. pkg-config --variable=completionsdir bash-completion).
18 # If your bash completion script is somewhere else, you can specify the
19 # location in your ~/.zshrc:
21 # zstyle ':completion:*:*:git:*' script ~/.git-completion.bash
24 zstyle
-T ':completion:*:*:git:*' tag-order
&& \
25 zstyle
':completion:*:*:git:*' tag-order
'common-commands'
27 zstyle
-s ":completion:*:*:git:*" script script
28 if [ -z "$script" ]; then
30 local e bash_completion
32 bash_completion
=$
(pkg-config
--variable=completionsdir bash-completion
2>/dev
/null
) ||
33 bash_completion
='/usr/share/bash-completion/completions/'
36 "$(dirname ${funcsourcetrace[1]%:*})"/git-completion.bash
37 "$HOME/.local/share/bash-completion/completions/git"
38 "$bash_completion/git"
39 '/etc/bash_completion.d/git' # old debian
41 for e
in $locations; do
42 test -f $e && script="$e" && break
46 local old_complete
="$functions[complete]"
48 GIT_SOURCING_ZSH_COMPLETION
=y .
"$script"
49 functions
[complete
]="$old_complete"
55 local cur_
="${3-$cur}"
64 if [[ $c == "--" ]]; then
75 compadd
-Q -S '' -p "${2-}" -a -- array
&& _ret
=0
81 if [[ $c == "--" ]]; then
94 compadd
-Q -S '' -p "${2-}" -a -- array
&& _ret
=0
104 compadd
-Q -S '' -- ${(f)1} && _ret
=0
112 compadd
-Q -S "${4- }" -p "${2-}" -- ${(f)1} && _ret=0
120 compadd -f -p "${2-}" -- ${(f)1} && _ret=0
123 __gitcomp_direct_append ()
125 __gitcomp_direct "$@
"
128 __gitcomp_nl_append ()
133 __gitcomp_file_direct ()
135 __gitcomp_file "$1" ""
143 __git_complete_command ()
148 local completion_func="_git_
${command//-/_}"
149 if (( $+functions[$completion_func] )); then
150 emulate ksh -c $completion_func
157 __git_zsh_bash_func ()
163 __git_complete_command "$command" && return
165 local expansion=$(__git_aliased_command "$command")
166 if [ -n "$expansion" ]; then
168 __git_complete_command "$expansion"
172 __git_zsh_cmd_common ()
176 add:'add file contents to the index'
177 bisect:'find by binary search the change that introduced a bug'
178 branch:'list, create, or delete branches'
179 checkout:'checkout a branch or paths to the working tree'
180 clone:'clone a repository into a new directory'
181 commit:'record changes to the repository'
182 diff:'show changes between commits, commit and working tree, etc'
183 fetch:'download objects and refs from another repository'
184 grep:'print lines matching a pattern'
185 init:'create an empty Git repository or reinitialize an existing one'
186 log:'show commit logs'
187 merge:'join two or more development histories together'
188 mv:'move or rename a file, a directory, or a symlink'
189 pull:'fetch from and merge with another repository or a local branch'
190 push:'update remote refs along with associated objects'
191 rebase:'forward-port local commits to the updated upstream head'
192 reset:'reset current HEAD to the specified state'
193 restore:'restore working tree files'
194 rm:'remove files from the working tree and from the index'
195 show:'show various types of objects'
196 status:'show the working tree status'
197 switch:'switch branches'
198 tag:'create, list, delete or verify a tag object signed with GPG')
199 _describe -t common-commands 'common commands' list && _ret=0
202 __git_zsh_cmd_alias ()
205 list=(${${(0)"$(git config -z --get-regexp '^alias\.*')"}#alias.})
206 list=(${(f)"$(printf "%s:alias for '%s'\n" ${(f@)list})"})
207 _describe -t alias-commands 'aliases' list && _ret=0
213 emulate ksh -c __git_compute_all_commands
214 list=( ${=__git_all_commands} )
215 _describe -t all-commands 'all commands' list && _ret=0
220 local curcontext="$curcontext" state state_descr line
224 orig_words=( ${words[@]} )
227 '(-p --paginate --no-pager)'{-p,--paginate}'[pipe all output into ''less'']' \
228 '(-p --paginate)--no-pager[do not pipe git output into a pager]' \
229 '--git-dir=-[set the path to the repository]: :_directories' \
230 '--bare[treat the repository as a bare repository]' \
231 '(- :)--version[prints the git suite version]' \
232 '--exec-path=-[path to where your core git programs are installed]:: :_directories' \
233 '--html-path[print the path where git''s HTML documentation is installed]' \
234 '--info-path[print the path where the Info files are installed]' \
235 '--man-path[print the manpath (see `man(1)`) for the man pages]' \
236 '--work-tree=-[set the path to the working tree]: :_directories' \
237 '--namespace=-[set the git namespace]' \
238 '--no-replace-objects[do not use replacement refs to replace git objects]' \
239 '(- :)--help[prints the synopsis and a list of the most commonly used commands]: :->arg' \
241 '(-)*:: :->arg' && return
245 _tags common-commands alias-commands all-commands
247 _requested common-commands && __git_zsh_cmd_common
248 _requested alias-commands && __git_zsh_cmd_alias
249 _requested all-commands && __git_zsh_cmd_all
254 local command="${words[1]}" __git_dir __git_cmd_idx=1
256 if (( $+opt_args[--bare] )); then
259 __git_dir=${opt_args[--git-dir]}
262 (( $+opt_args[--help] )) && command='help'
264 words=( ${orig_words[@]} )
266 __git_zsh_bash_func $command
276 cur=${words[CURRENT]}
277 prev=${words[CURRENT-1]}
280 if (( $+functions[__${service}_zsh_main] )); then
281 __${service}_zsh_main
282 elif (( $+functions[__${service}_main] )); then
283 emulate ksh -c __${service}_main
284 elif (( $+functions[_${service}] )); then
285 emulate ksh -c _${service}
286 elif (( $+functions[_${service//-/_}] )); then
287 emulate ksh -c _${service//-/_}
290 let _ret && _default && _ret=0