[thirdparty/git.git] / contrib / completion / git-completion.zsh

#compdef git gitk

# zsh completion wrapper for git
#
# Copyright (c) 2012-2020 Felipe Contreras <felipe.contreras@gmail.com>
#
# 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.
#
# For example, create a directory '~/.zsh/', copy this file to '~/.zsh/_git',
# and then add the following to your ~/.zshrc file:
#
#  fpath=(~/.zsh $fpath)
#
# 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
#

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

zstyle -s ":completion:*:*:git:*" script script
if [ -z "$script" ]; then
	local -a locations
	local e bash_completion

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

	locations=(
		"$(dirname ${funcsourcetrace[1]%:*})"/git-completion.bash
		"$HOME/.local/share/bash-completion/completions/git"
		"$bash_completion/git"
		'/etc/bash_completion.d/git' # old debian
		)
	for e in $locations; do
		test -f $e && script="$e" && break
	done
fi

local old_complete="$functions[complete]"
functions[complete]=:
GIT_SOURCING_ZSH_COMPLETION=y . "$script"
functions[complete]="$old_complete"

__gitcomp ()
{
	emulate -L zsh

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

	case "$cur_" in
	--*=)
		;;
	--no-*)
		local c IFS=$' \t\n'
		local -a array
		for c in ${=1}; do
			if [[ $c == "--" ]]; then
				continue
			fi
			c="$c${4-}"
			case $c in
			--*=|*.) ;;
			*) c="$c " ;;
			esac
			array+=("$c")
		done
		compset -P '*[=:]'
		compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
		;;
	*)
		local c IFS=$' \t\n'
		local -a array
		for c in ${=1}; do
			if [[ $c == "--" ]]; then
				c="--no-...${4-}"
				array+=("$c ")
				break
			fi
			c="$c${4-}"
			case $c in
			--*=|*.) ;;
			*) c="$c " ;;
			esac
			array+=("$c")
		done
		compset -P '*[=:]'
		compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
		;;
	esac
}

__gitcomp_direct ()
{
	emulate -L zsh

	compset -P '*[=:]'
	compadd -Q -S '' -- ${(f)1} && _ret=0
}

__gitcomp_nl ()
{
	emulate -L zsh

	compset -P '*[=:]'
	compadd -Q -S "${4- }" -p "${2-}" -- ${(f)1} && _ret=0
}

__gitcomp_file ()
{
	emulate -L zsh

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

__gitcomp_direct_append ()
{
	__gitcomp_direct "$@"
}

__gitcomp_nl_append ()
{
	__gitcomp_nl "$@"
}

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

_git_zsh ()
{
	__gitcomp "v1.1"
}

__git_complete_command ()
{
	emulate -L zsh

	local command="$1"
	local completion_func="_git_${command//-/_}"
	if (( $+functions[$completion_func] )); then
		emulate ksh -c $completion_func
		return 0
	else
		return 1
	fi
}

__git_zsh_bash_func ()
{
	emulate -L ksh

	local command=$1

	__git_complete_command "$command" && return

	local expansion=$(__git_aliased_command "$command")
	if [ -n "$expansion" ]; then
		words[1]=$expansion
		__git_complete_command "$expansion"
	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'
	restore:'restore working tree files'
	rm:'remove files from the working tree and from the index'
	show:'show various types of objects'
	status:'show the working tree status'
	switch:'switch branches'
	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
	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
}

__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
	local -a orig_words

	orig_words=( ${words[@]} )

	_arguments -C \
		'(-p --paginate --no-pager)'{-p,--paginate}'[pipe all output into ''less'']' \
		'(-p --paginate)--no-pager[do not pipe git output into a pager]' \
		'--git-dir=-[set the path to the repository]: :_directories' \
		'--bare[treat the repository as a bare repository]' \
		'(- :)--version[prints the git suite version]' \
		'--exec-path=-[path to where your core git programs are installed]:: :_directories' \
		'--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]' \
		'--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' \
		'(-): :->command' \
		'(-)*:: :->arg' && return

	case $state in
	(command)
		_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
		;;
	(arg)
		local command="${words[1]}" __git_dir

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

		(( $+opt_args[--help] )) && command='help'

		words=( ${orig_words[@]} )

		__git_zsh_bash_func $command
		;;
	esac
}

_git ()
{
	local _ret=1
	local cur cword prev

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

	if (( $+functions[__${service}_zsh_main] )); then
		__${service}_zsh_main
	elif (( $+functions[__${service}_main] )); then
		emulate ksh -c __${service}_main
	elif (( $+functions[_${service}] )); then
		emulate ksh -c _${service}
	elif ((	$+functions[_${service//-/_}] )); then
		emulate ksh -c _${service//-/_}
	fi

	let _ret && _default && _ret=0
	return _ret
}

_git
Commit	Line	Data
c9407860 FC	1	#compdef git gitk
	2
	3	# zsh completion wrapper for git
	4	#
af806a2c	5	# Copyright (c) 2012-2020 Felipe Contreras <felipe.contreras@gmail.com>
4911589b	6	#
5eb25bcf FC	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.
	9	#
	10	# For example, create a directory '~/.zsh/', copy this file to '~/.zsh/_git',
	11	# and then add the following to your ~/.zshrc file:
c9407860	12	#
3646b1a5	13	# fpath=(~/.zsh $fpath)
cb9dcbdb FC	14	#
cb9dcbdb FC	15	# You need git's bash completion script installed. By default bash-completion's
98fc2684	16	# location will be used (e.g. pkg-config --variable=completionsdir bash-completion).
cb9dcbdb FC	17	#
	18	# If your bash completion script is somewhere else, you can specify the
	19	# location in your ~/.zshrc:
	20	#
	21	# zstyle ':completion:::git:*' script ~/.git-completion.bash
	22	#
c9407860	23
4911589b FC	24	zstyle -T ':completion:::git:*' tag-order && \
	25	zstyle ':completion:::git:*' tag-order 'common-commands'
	26
c9407860	27	zstyle -s ":completion:::git:*" script script
3646b1a5 FC	28	if [ -z "$script" ]; then
3646b1a5 FC	29	local -a locations
98fc2684 FC	30	local e bash_completion
	31
	32	bash_completion=$(pkg-config --variable=completionsdir bash-completion 2>/dev/null) \|\|
	33	bash_completion='/usr/share/bash-completion/completions/'
	34
3646b1a5	35	locations=(
44b37abb	36	"$(dirname ${funcsourcetrace[1]%:*})"/git-completion.bash
98fc2684 FC	37	"$HOME/.local/share/bash-completion/completions/git"
	38	"$bash_completion/git"
	39	'/etc/bash_completion.d/git' # old debian
3646b1a5 FC	40	)
	41	for e in $locations; do
	42	test -f $e && script="$e" && break
	43	done
	44	fi
3791968b FC	45
	46	local old_complete="$functions[complete]"
	47	functions[complete]=:
61d48c66	48	GIT_SOURCING_ZSH_COMPLETION=y . "$script"
3791968b	49	functions[complete]="$old_complete"
c9407860 FC	50
	51	__gitcomp ()
	52	{
	53	emulate -L zsh
	54
	55	local cur_="${3-$cur}"
	56
	57	case "$cur_" in
	58	--*=)
	59	;;
aa1f1f80 FC	60	--no-*)
	61	local c IFS=$' \t\n'
	62	local -a array
	63	for c in ${=1}; do
	64	if [[ $c == "--" ]]; then
	65	continue
	66	fi
	67	c="$c${4-}"
	68	case $c in
	69	--=\|.) ;;
	70	*) c="$c " ;;
	71	esac
	72	array+=("$c")
	73	done
	74	compset -P '*[=:]'
	75	compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
	76	;;
c9407860 FC	77	*)
	78	local c IFS=$' \t\n'
	79	local -a array
	80	for c in ${=1}; do
aa1f1f80 FC	81	if [[ $c == "--" ]]; then
	82	c="--no-...${4-}"
	83	array+=("$c ")
	84	break
	85	fi
c9407860 FC	86	c="$c${4-}"
c9407860 FC	87	case $c in
bbd7f458	88	--=\|.) ;;
c9407860 FC	89	*) c="$c " ;;
	90	esac
	91	array+=("$c")
	92	done
	93	compset -P '*[=:]'
	94	compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
	95	;;
	96	esac
	97	}
	98
fef56eb0 SG	99	__gitcomp_direct ()
	100	{
	101	emulate -L zsh
	102
fef56eb0	103	compset -P '*[=:]'
ecaf7989	104	compadd -Q -S '' -- ${(f)1} && _ret=0
fef56eb0 SG	105	}
fef56eb0 SG	106
c9407860 FC	107	__gitcomp_nl ()
	108	{
	109	emulate -L zsh
	110
c9407860	111	compset -P '*[=:]'
2f459b00	112	compadd -Q -S "${4- }" -p "${2-}" -- ${(f)1} && _ret=0
c9407860 FC	113	}
c9407860 FC	114
46af9b37	115	__gitcomp_file ()
f33c2c0f	116	{
46af9b37 FC	117	emulate -L zsh
	118
	119	compadd -f -p "${2-}" -- ${(f)1} && _ret=0
f33c2c0f RR	120	}
f33c2c0f RR	121
46af9b37	122	__gitcomp_direct_append ()
7b003420	123	{
46af9b37	124	__gitcomp_direct "$@"
7b003420 SG	125	}
7b003420 SG	126
46af9b37	127	__gitcomp_nl_append ()
926eb7ba	128	{
46af9b37 FC	129	__gitcomp_nl "$@"
46af9b37 FC	130	}
926eb7ba	131
46af9b37 FC	132	__gitcomp_file_direct ()
	133	{
	134	__gitcomp_file "$1" ""
926eb7ba MM	135	}
926eb7ba MM	136
35a4170d FC	137	_git_zsh ()
	138	{
	139	__gitcomp "v1.1"
	140	}
	141
9a397ea5 FC	142	__git_complete_command ()
	143	{
	144	emulate -L zsh
	145
	146	local command="$1"
	147	local completion_func="_git_${command//-/_}"
	148	if (( $+functions[$completion_func] )); then
	149	emulate ksh -c $completion_func
	150	return 0
	151	else
	152	return 1
	153	fi
	154	}
	155
4911589b FC	156	__git_zsh_bash_func ()
	157	{
	158	emulate -L ksh
	159
	160	local command=$1
	161
9a397ea5	162	__git_complete_command "$command" && return
4911589b FC	163
	164	local expansion=$(__git_aliased_command "$command")
	165	if [ -n "$expansion" ]; then
880111c1	166	words[1]=$expansion
9a397ea5	167	__git_complete_command "$expansion"
4911589b FC	168	fi
	169	}
	170
	171	__git_zsh_cmd_common ()
	172	{
	173	local -a list
	174	list=(
	175	add:'add file contents to the index'
	176	bisect:'find by binary search the change that introduced a bug'
	177	branch:'list, create, or delete branches'
	178	checkout:'checkout a branch or paths to the working tree'
	179	clone:'clone a repository into a new directory'
	180	commit:'record changes to the repository'
	181	diff:'show changes between commits, commit and working tree, etc'
	182	fetch:'download objects and refs from another repository'
	183	grep:'print lines matching a pattern'
	184	init:'create an empty Git repository or reinitialize an existing one'
	185	log:'show commit logs'
	186	merge:'join two or more development histories together'
	187	mv:'move or rename a file, a directory, or a symlink'
	188	pull:'fetch from and merge with another repository or a local branch'
	189	push:'update remote refs along with associated objects'
	190	rebase:'forward-port local commits to the updated upstream head'
	191	reset:'reset current HEAD to the specified state'
051cc549	192	restore:'restore working tree files'
4911589b FC	193	rm:'remove files from the working tree and from the index'
	194	show:'show various types of objects'
	195	status:'show the working tree status'
051cc549	196	switch:'switch branches'
4911589b FC	197	tag:'create, list, delete or verify a tag object signed with GPG')
	198	_describe -t common-commands 'common commands' list && _ret=0
	199	}
	200
	201	__git_zsh_cmd_alias ()
	202	{
	203	local -a list
2769e567 FC	204	list=(${${(0)"$(git config -z --get-regexp '^alias\.*')"}#alias.})
	205	list=(${(f)"$(printf "%s:alias for '%s'\n" ${(f@)list})"})
	206	_describe -t alias-commands 'aliases' list && _ret=0
4911589b FC	207	}
	208
	209	__git_zsh_cmd_all ()
	210	{
	211	local -a list
	212	emulate ksh -c __git_compute_all_commands
	213	list=( ${=__git_all_commands} )
	214	_describe -t all-commands 'all commands' list && _ret=0
	215	}
	216
	217	__git_zsh_main ()
	218	{
	219	local curcontext="$curcontext" state state_descr line
	220	typeset -A opt_args
	221	local -a orig_words
	222
	223	orig_words=( ${words[@]} )
	224
	225	_arguments -C \
	226	'(-p --paginate --no-pager)'{-p,--paginate}'[pipe all output into ''less'']' \
	227	'(-p --paginate)--no-pager[do not pipe git output into a pager]' \
	228	'--git-dir=-[set the path to the repository]: :_directories' \
	229	'--bare[treat the repository as a bare repository]' \
	230	'(- :)--version[prints the git suite version]' \
	231	'--exec-path=-[path to where your core git programs are installed]:: :_directories' \
	232	'--html-path[print the path where git''s HTML documentation is installed]' \
	233	'--info-path[print the path where the Info files are installed]' \
	234	'--man-path[print the manpath (see `man(1)`) for the man pages]' \
	235	'--work-tree=-[set the path to the working tree]: :_directories' \
	236	'--namespace=-[set the git namespace]' \
	237	'--no-replace-objects[do not use replacement refs to replace git objects]' \
	238	'(- :)--help[prints the synopsis and a list of the most commonly used commands]: :->arg' \
	239	'(-): :->command' \
	240	'(-)*:: :->arg' && return
	241
	242	case $state in
	243	(command)
9d760527 FC	244	_tags common-commands alias-commands all-commands
	245	while _tags; do
	246	_requested common-commands && __git_zsh_cmd_common
	247	_requested alias-commands && __git_zsh_cmd_alias
	248	_requested all-commands && __git_zsh_cmd_all
	249	let _ret \|\| break
	250	done
4911589b FC	251	;;
	252	(arg)
	253	local command="${words[1]}" __git_dir
	254
	255	if (( $+opt_args[--bare] )); then
	256	__git_dir='.'
	257	else
	258	__git_dir=${opt_args[--git-dir]}
	259	fi
	260
	261	(( $+opt_args[--help] )) && command='help'
	262
	263	words=( ${orig_words[@]} )
	264
	265	__git_zsh_bash_func $command
	266	;;
	267	esac
	268	}
	269
c9407860 FC	270	_git ()
	271	{
	272	local _ret=1
1ca6d4bc FC	273	local cur cword prev
	274
	275	cur=${words[CURRENT]}
	276	prev=${words[CURRENT-1]}
	277	let cword=CURRENT-1
	278
4911589b FC	279	if (( $+functions[__${service}_zsh_main] )); then
4911589b FC	280	__${service}_zsh_main
81f717bb	281	elif (( $+functions[__${service}_main] )); then
4911589b	282	emulate ksh -c __${service}_main
81f717bb FC	283	elif (( $+functions[_${service}] )); then
	284	emulate ksh -c _${service}
	285	elif (( $+functions[_${service//-/_}] )); then
	286	emulate ksh -c _${service//-/_}
4911589b	287	fi
1ca6d4bc	288
6606a69f	289	let _ret && _default && _ret=0
c9407860 FC	290	return _ret
	291	}
	292
	293	_git