Merge branch 'tf/prompt-preserve-exit-status'
[git/git-svn.git] / contrib / completion / git-prompt.sh
blob214e859f99e7d896a6fa45a737b5b3e2a629176f
1 # bash/zsh git prompt support
3 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
4 # Distributed under the GNU General Public License, version 2.0.
6 # This script allows you to see repository status in your prompt.
8 # To enable:
10 # 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
11 # 2) Add the following line to your .bashrc/.zshrc:
12 # source ~/.git-prompt.sh
13 # 3a) Change your PS1 to call __git_ps1 as
14 # command-substitution:
15 # Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
16 # ZSH: setopt PROMPT_SUBST ; PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '
17 # the optional argument will be used as format string.
18 # 3b) Alternatively, for a slightly faster prompt, __git_ps1 can
19 # be used for PROMPT_COMMAND in Bash or for precmd() in Zsh
20 # with two parameters, <pre> and <post>, which are strings
21 # you would put in $PS1 before and after the status string
22 # generated by the git-prompt machinery. e.g.
23 # Bash: PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
24 # will show username, at-sign, host, colon, cwd, then
25 # various status string, followed by dollar and SP, as
26 # your prompt.
27 # ZSH: precmd () { __git_ps1 "%n" ":%~$ " "|%s" }
28 # will show username, pipe, then various status string,
29 # followed by colon, cwd, dollar and SP, as your prompt.
30 # Optionally, you can supply a third argument with a printf
31 # format string to finetune the output of the branch status
33 # The repository status will be displayed only if you are currently in a
34 # git repository. The %s token is the placeholder for the shown status.
36 # The prompt status always includes the current branch name.
38 # In addition, if you set GIT_PS1_SHOWDIRTYSTATE to a nonempty value,
39 # unstaged (*) and staged (+) changes will be shown next to the branch
40 # name. You can configure this per-repository with the
41 # bash.showDirtyState variable, which defaults to true once
42 # GIT_PS1_SHOWDIRTYSTATE is enabled.
44 # You can also see if currently something is stashed, by setting
45 # GIT_PS1_SHOWSTASHSTATE to a nonempty value. If something is stashed,
46 # then a '$' will be shown next to the branch name.
48 # If you would like to see if there're untracked files, then you can set
49 # GIT_PS1_SHOWUNTRACKEDFILES to a nonempty value. If there're untracked
50 # files, then a '%' will be shown next to the branch name. You can
51 # configure this per-repository with the bash.showUntrackedFiles
52 # variable, which defaults to true once GIT_PS1_SHOWUNTRACKEDFILES is
53 # enabled.
55 # If you would like to see the difference between HEAD and its upstream,
56 # set GIT_PS1_SHOWUPSTREAM="auto". A "<" indicates you are behind, ">"
57 # indicates you are ahead, "<>" indicates you have diverged and "="
58 # indicates that there is no difference. You can further control
59 # behaviour by setting GIT_PS1_SHOWUPSTREAM to a space-separated list
60 # of values:
62 # verbose show number of commits ahead/behind (+/-) upstream
63 # name if verbose, then also show the upstream abbrev name
64 # legacy don't use the '--count' option available in recent
65 # versions of git-rev-list
66 # git always compare HEAD to @{upstream}
67 # svn always compare HEAD to your SVN upstream
69 # By default, __git_ps1 will compare HEAD to your SVN upstream if it can
70 # find one, or @{upstream} otherwise. Once you have set
71 # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
72 # setting the bash.showUpstream config variable.
74 # If you would like to see more information about the identity of
75 # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
76 # to one of these values:
78 # contains relative to newer annotated tag (v1.6.3.2~35)
79 # branch relative to newer tag or branch (master~4)
80 # describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
81 # default exactly matching tag
83 # If you would like a colored hint about the current dirty state, set
84 # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
85 # the colored output of "git status -sb" and are available only when
86 # using __git_ps1 for PROMPT_COMMAND or precmd.
88 # If you would like __git_ps1 to do nothing in the case when the current
89 # directory is set up to be ignored by git, then set
90 # GIT_PS1_HIDE_IF_PWD_IGNORED to a nonempty value. Override this on the
91 # repository level by setting bash.hideIfPwdIgnored to "false".
93 # check whether printf supports -v
94 __git_printf_supports_v=
95 printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
97 # stores the divergence from upstream in $p
98 # used by GIT_PS1_SHOWUPSTREAM
99 __git_ps1_show_upstream ()
101 local key value
102 local svn_remote svn_url_pattern count n
103 local upstream=git legacy="" verbose="" name=""
105 svn_remote=()
106 # get some config options from git-config
107 local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
108 while read -r key value; do
109 case "$key" in
110 bash.showupstream)
111 GIT_PS1_SHOWUPSTREAM="$value"
112 if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
113 p=""
114 return
117 svn-remote.*.url)
118 svn_remote[$((${#svn_remote[@]} + 1))]="$value"
119 svn_url_pattern="$svn_url_pattern\\|$value"
120 upstream=svn+git # default upstream is SVN if available, else git
122 esac
123 done <<< "$output"
125 # parse configuration values
126 for option in ${GIT_PS1_SHOWUPSTREAM}; do
127 case "$option" in
128 git|svn) upstream="$option" ;;
129 verbose) verbose=1 ;;
130 legacy) legacy=1 ;;
131 name) name=1 ;;
132 esac
133 done
135 # Find our upstream
136 case "$upstream" in
137 git) upstream="@{upstream}" ;;
138 svn*)
139 # get the upstream from the "git-svn-id: ..." in a commit message
140 # (git-svn uses essentially the same procedure internally)
141 local -a svn_upstream
142 svn_upstream=($(git log --first-parent -1 \
143 --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
144 if [[ 0 -ne ${#svn_upstream[@]} ]]; then
145 svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
146 svn_upstream=${svn_upstream%@*}
147 local n_stop="${#svn_remote[@]}"
148 for ((n=1; n <= n_stop; n++)); do
149 svn_upstream=${svn_upstream#${svn_remote[$n]}}
150 done
152 if [[ -z "$svn_upstream" ]]; then
153 # default branch name for checkouts with no layout:
154 upstream=${GIT_SVN_ID:-git-svn}
155 else
156 upstream=${svn_upstream#/}
158 elif [[ "svn+git" = "$upstream" ]]; then
159 upstream="@{upstream}"
162 esac
164 # Find how many commits we are ahead/behind our upstream
165 if [[ -z "$legacy" ]]; then
166 count="$(git rev-list --count --left-right \
167 "$upstream"...HEAD 2>/dev/null)"
168 else
169 # produce equivalent output to --count for older versions of git
170 local commits
171 if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)"
172 then
173 local commit behind=0 ahead=0
174 for commit in $commits
176 case "$commit" in
177 "<"*) ((behind++)) ;;
178 *) ((ahead++)) ;;
179 esac
180 done
181 count="$behind $ahead"
182 else
183 count=""
187 # calculate the result
188 if [[ -z "$verbose" ]]; then
189 case "$count" in
190 "") # no upstream
191 p="" ;;
192 "0 0") # equal to upstream
193 p="=" ;;
194 "0 "*) # ahead of upstream
195 p=">" ;;
196 *" 0") # behind upstream
197 p="<" ;;
198 *) # diverged from upstream
199 p="<>" ;;
200 esac
201 else
202 case "$count" in
203 "") # no upstream
204 p="" ;;
205 "0 0") # equal to upstream
206 p=" u=" ;;
207 "0 "*) # ahead of upstream
208 p=" u+${count#0 }" ;;
209 *" 0") # behind upstream
210 p=" u-${count% 0}" ;;
211 *) # diverged from upstream
212 p=" u+${count#* }-${count% *}" ;;
213 esac
214 if [[ -n "$count" && -n "$name" ]]; then
215 __git_ps1_upstream_name=$(git rev-parse \
216 --abbrev-ref "$upstream" 2>/dev/null)
217 if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
218 p="$p \${__git_ps1_upstream_name}"
219 else
220 p="$p ${__git_ps1_upstream_name}"
221 # not needed anymore; keep user's
222 # environment clean
223 unset __git_ps1_upstream_name
230 # Helper function that is meant to be called from __git_ps1. It
231 # injects color codes into the appropriate gitstring variables used
232 # to build a gitstring.
233 __git_ps1_colorize_gitstring ()
235 if [[ -n ${ZSH_VERSION-} ]]; then
236 local c_red='%F{red}'
237 local c_green='%F{green}'
238 local c_lblue='%F{blue}'
239 local c_clear='%f'
240 else
241 # Using \[ and \] around colors is necessary to prevent
242 # issues with command line editing/browsing/completion!
243 local c_red='\[\e[31m\]'
244 local c_green='\[\e[32m\]'
245 local c_lblue='\[\e[1;34m\]'
246 local c_clear='\[\e[0m\]'
248 local bad_color=$c_red
249 local ok_color=$c_green
250 local flags_color="$c_lblue"
252 local branch_color=""
253 if [ $detached = no ]; then
254 branch_color="$ok_color"
255 else
256 branch_color="$bad_color"
258 c="$branch_color$c"
260 z="$c_clear$z"
261 if [ "$w" = "*" ]; then
262 w="$bad_color$w"
264 if [ -n "$i" ]; then
265 i="$ok_color$i"
267 if [ -n "$s" ]; then
268 s="$flags_color$s"
270 if [ -n "$u" ]; then
271 u="$bad_color$u"
273 r="$c_clear$r"
276 __git_eread ()
278 local f="$1"
279 shift
280 test -r "$f" && read "$@" <"$f"
283 # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
284 # when called from PS1 using command substitution
285 # in this mode it prints text to add to bash PS1 prompt (includes branch name)
287 # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
288 # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
289 # when two arguments are given, the first is prepended and the second appended
290 # to the state string when assigned to PS1.
291 # The optional third parameter will be used as printf format string to further
292 # customize the output of the git-status string.
293 # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
294 __git_ps1 ()
296 # preserve exit status
297 local exit=$?
298 local pcmode=no
299 local detached=no
300 local ps1pc_start='\u@\h:\w '
301 local ps1pc_end='\$ '
302 local printf_format=' (%s)'
304 case "$#" in
305 2|3) pcmode=yes
306 ps1pc_start="$1"
307 ps1pc_end="$2"
308 printf_format="${3:-$printf_format}"
309 # set PS1 to a plain prompt so that we can
310 # simply return early if the prompt should not
311 # be decorated
312 PS1="$ps1pc_start$ps1pc_end"
314 0|1) printf_format="${1:-$printf_format}"
316 *) return $exit
318 esac
320 # ps1_expanded: This variable is set to 'yes' if the shell
321 # subjects the value of PS1 to parameter expansion:
323 # * bash does unless the promptvars option is disabled
324 # * zsh does not unless the PROMPT_SUBST option is set
325 # * POSIX shells always do
327 # If the shell would expand the contents of PS1 when drawing
328 # the prompt, a raw ref name must not be included in PS1.
329 # This protects the user from arbitrary code execution via
330 # specially crafted ref names. For example, a ref named
331 # 'refs/heads/$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)' might cause the
332 # shell to execute 'sudo rm -rf /' when the prompt is drawn.
334 # Instead, the ref name should be placed in a separate global
335 # variable (in the __git_ps1_* namespace to avoid colliding
336 # with the user's environment) and that variable should be
337 # referenced from PS1. For example:
339 # __git_ps1_foo=$(do_something_to_get_ref_name)
340 # PS1="...stuff...\${__git_ps1_foo}...stuff..."
342 # If the shell does not expand the contents of PS1, the raw
343 # ref name must be included in PS1.
345 # The value of this variable is only relevant when in pcmode.
347 # Assume that the shell follows the POSIX specification and
348 # expands PS1 unless determined otherwise. (This is more
349 # likely to be correct if the user has a non-bash, non-zsh
350 # shell and safer than the alternative if the assumption is
351 # incorrect.)
353 local ps1_expanded=yes
354 [ -z "$ZSH_VERSION" ] || [[ -o PROMPT_SUBST ]] || ps1_expanded=no
355 [ -z "$BASH_VERSION" ] || shopt -q promptvars || ps1_expanded=no
357 local repo_info rev_parse_exit_code
358 repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
359 --is-bare-repository --is-inside-work-tree \
360 --short HEAD 2>/dev/null)"
361 rev_parse_exit_code="$?"
363 if [ -z "$repo_info" ]; then
364 return $exit
367 local short_sha
368 if [ "$rev_parse_exit_code" = "0" ]; then
369 short_sha="${repo_info##*$'\n'}"
370 repo_info="${repo_info%$'\n'*}"
372 local inside_worktree="${repo_info##*$'\n'}"
373 repo_info="${repo_info%$'\n'*}"
374 local bare_repo="${repo_info##*$'\n'}"
375 repo_info="${repo_info%$'\n'*}"
376 local inside_gitdir="${repo_info##*$'\n'}"
377 local g="${repo_info%$'\n'*}"
379 if [ "true" = "$inside_worktree" ] &&
380 [ -n "${GIT_PS1_HIDE_IF_PWD_IGNORED-}" ] &&
381 [ "$(git config --bool bash.hideIfPwdIgnored)" != "false" ] &&
382 git check-ignore -q .
383 then
384 return $exit
387 local r=""
388 local b=""
389 local step=""
390 local total=""
391 if [ -d "$g/rebase-merge" ]; then
392 __git_eread "$g/rebase-merge/head-name" b
393 __git_eread "$g/rebase-merge/msgnum" step
394 __git_eread "$g/rebase-merge/end" total
395 if [ -f "$g/rebase-merge/interactive" ]; then
396 r="|REBASE-i"
397 else
398 r="|REBASE-m"
400 else
401 if [ -d "$g/rebase-apply" ]; then
402 __git_eread "$g/rebase-apply/next" step
403 __git_eread "$g/rebase-apply/last" total
404 if [ -f "$g/rebase-apply/rebasing" ]; then
405 __git_eread "$g/rebase-apply/head-name" b
406 r="|REBASE"
407 elif [ -f "$g/rebase-apply/applying" ]; then
408 r="|AM"
409 else
410 r="|AM/REBASE"
412 elif [ -f "$g/MERGE_HEAD" ]; then
413 r="|MERGING"
414 elif [ -f "$g/CHERRY_PICK_HEAD" ]; then
415 r="|CHERRY-PICKING"
416 elif [ -f "$g/REVERT_HEAD" ]; then
417 r="|REVERTING"
418 elif [ -f "$g/BISECT_LOG" ]; then
419 r="|BISECTING"
422 if [ -n "$b" ]; then
424 elif [ -h "$g/HEAD" ]; then
425 # symlink symbolic ref
426 b="$(git symbolic-ref HEAD 2>/dev/null)"
427 else
428 local head=""
429 if ! __git_eread "$g/HEAD" head; then
430 return $exit
432 # is it a symbolic ref?
433 b="${head#ref: }"
434 if [ "$head" = "$b" ]; then
435 detached=yes
436 b="$(
437 case "${GIT_PS1_DESCRIBE_STYLE-}" in
438 (contains)
439 git describe --contains HEAD ;;
440 (branch)
441 git describe --contains --all HEAD ;;
442 (describe)
443 git describe HEAD ;;
444 (* | default)
445 git describe --tags --exact-match HEAD ;;
446 esac 2>/dev/null)" ||
448 b="$short_sha..."
449 b="($b)"
454 if [ -n "$step" ] && [ -n "$total" ]; then
455 r="$r $step/$total"
458 local w=""
459 local i=""
460 local s=""
461 local u=""
462 local c=""
463 local p=""
465 if [ "true" = "$inside_gitdir" ]; then
466 if [ "true" = "$bare_repo" ]; then
467 c="BARE:"
468 else
469 b="GIT_DIR!"
471 elif [ "true" = "$inside_worktree" ]; then
472 if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
473 [ "$(git config --bool bash.showDirtyState)" != "false" ]
474 then
475 git diff --no-ext-diff --quiet --exit-code || w="*"
476 if [ -n "$short_sha" ]; then
477 git diff-index --cached --quiet HEAD -- || i="+"
478 else
479 i="#"
482 if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
483 git rev-parse --verify --quiet refs/stash >/dev/null
484 then
485 s="$"
488 if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
489 [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
490 git ls-files --others --exclude-standard --error-unmatch -- '*' >/dev/null 2>/dev/null
491 then
492 u="%${ZSH_VERSION+%}"
495 if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
496 __git_ps1_show_upstream
500 local z="${GIT_PS1_STATESEPARATOR-" "}"
502 # NO color option unless in PROMPT_COMMAND mode
503 if [ $pcmode = yes ] && [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
504 __git_ps1_colorize_gitstring
507 b=${b##refs/heads/}
508 if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
509 __git_ps1_branch_name=$b
510 b="\${__git_ps1_branch_name}"
513 local f="$w$i$s$u"
514 local gitstring="$c$b${f:+$z$f}$r$p"
516 if [ $pcmode = yes ]; then
517 if [ "${__git_printf_supports_v-}" != yes ]; then
518 gitstring=$(printf -- "$printf_format" "$gitstring")
519 else
520 printf -v gitstring -- "$printf_format" "$gitstring"
522 PS1="$ps1pc_start$gitstring$ps1pc_end"
523 else
524 printf -- "$printf_format" "$gitstring"
527 return $exit