git-prompt.sh
18461 bytes
1# bash/zsh git prompt support
2#
3# Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
4# Distributed under the GNU General Public License, version 2.0.
5#
6# This script allows you to see repository status in your prompt.
7#
8# To enable:
9#
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
32#
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.
35#
36# The prompt status always includes the current branch name.
37#
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.
43#
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.
47#
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.
54#
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:
61#
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
68#
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.
73#
74# You can change the separator between the branch name and the above
75# state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
76# is SP.
77#
78# When there is an in-progress operation such as a merge, rebase,
79# revert, cherry-pick, or bisect, the prompt will include information
80# related to the operation, often in the form "|<OPERATION-NAME>".
81#
82# When the repository has a sparse-checkout, a notification of the form
83# "|SPARSE" will be included in the prompt. This can be shortened to a
84# single '?' character by setting GIT_PS1_COMPRESSSPARSESTATE, or omitted
85# by setting GIT_PS1_OMITSPARSESTATE.
86#
87# If you would like to see a notification on the prompt when there are
88# unresolved conflicts, set GIT_PS1_SHOWCONFLICTSTATE to "yes". The
89# prompt will include "|CONFLICT".
90#
91# If you would like to see more information about the identity of
92# commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
93# to one of these values:
94#
95# contains relative to newer annotated tag (v1.6.3.2~35)
96# branch relative to newer tag or branch (master~4)
97# describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
98# tag relative to any older tag (v1.6.3.1-13-gdd42c2f)
99# default exactly matching tag
100#
101# If you would like a colored hint about the current dirty state, set
102# GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
103# the colored output of "git status -sb".
104#
105# If you would like __git_ps1 to do nothing in the case when the current
106# directory is set up to be ignored by git, then set
107# GIT_PS1_HIDE_IF_PWD_IGNORED to a nonempty value. Override this on the
108# repository level by setting bash.hideIfPwdIgnored to "false".
109
110# check whether printf supports -v
111__git_printf_supports_v=
112printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
113
114# stores the divergence from upstream in $p
115# used by GIT_PS1_SHOWUPSTREAM
116__git_ps1_show_upstream ()
117{
118 local key value
119 local svn_remote svn_url_pattern count n
120 local upstream_type=git legacy="" verbose="" name=""
121
122 svn_remote=()
123 # get some config options from git-config
124 local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
125 while read -r key value; do
126 case "$key" in
127 bash.showupstream)
128 GIT_PS1_SHOWUPSTREAM="$value"
129 if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
130 p=""
131 return
132 fi
133 ;;
134 svn-remote.*.url)
135 svn_remote[$((${#svn_remote[@]} + 1))]="$value"
136 svn_url_pattern="$svn_url_pattern\\|$value"
137 upstream_type=svn+git # default upstream type is SVN if available, else git
138 ;;
139 esac
140 done <<< "$output"
141
142 # parse configuration values
143 local option
144 for option in ${GIT_PS1_SHOWUPSTREAM}; do
145 case "$option" in
146 git|svn) upstream_type="$option" ;;
147 verbose) verbose=1 ;;
148 legacy) legacy=1 ;;
149 name) name=1 ;;
150 esac
151 done
152
153 # Find our upstream type
154 case "$upstream_type" in
155 git) upstream_type="@{upstream}" ;;
156 svn*)
157 # get the upstream from the "git-svn-id: ..." in a commit message
158 # (git-svn uses essentially the same procedure internally)
159 local -a svn_upstream
160 svn_upstream=($(git log --first-parent -1 \
161 --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
162 if [[ 0 -ne ${#svn_upstream[@]} ]]; then
163 svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
164 svn_upstream=${svn_upstream%@*}
165 local n_stop="${#svn_remote[@]}"
166 for ((n=1; n <= n_stop; n++)); do
167 svn_upstream=${svn_upstream#${svn_remote[$n]}}
168 done
169
170 if [[ -z "$svn_upstream" ]]; then
171 # default branch name for checkouts with no layout:
172 upstream_type=${GIT_SVN_ID:-git-svn}
173 else
174 upstream_type=${svn_upstream#/}
175 fi
176 elif [[ "svn+git" = "$upstream_type" ]]; then
177 upstream_type="@{upstream}"
178 fi
179 ;;
180 esac
181
182 # Find how many commits we are ahead/behind our upstream
183 if [[ -z "$legacy" ]]; then
184 count="$(git rev-list --count --left-right \
185 "$upstream_type"...HEAD 2>/dev/null)"
186 else
187 # produce equivalent output to --count for older versions of git
188 local commits
189 if commits="$(git rev-list --left-right "$upstream_type"...HEAD 2>/dev/null)"
190 then
191 local commit behind=0 ahead=0
192 for commit in $commits
193 do
194 case "$commit" in
195 "<"*) ((behind++)) ;;
196 *) ((ahead++)) ;;
197 esac
198 done
199 count="$behind $ahead"
200 else
201 count=""
202 fi
203 fi
204
205 # calculate the result
206 if [[ -z "$verbose" ]]; then
207 case "$count" in
208 "") # no upstream
209 p="" ;;
210 "0 0") # equal to upstream
211 p="=" ;;
212 "0 "*) # ahead of upstream
213 p=">" ;;
214 *" 0") # behind upstream
215 p="<" ;;
216 *) # diverged from upstream
217 p="<>" ;;
218 esac
219 else # verbose, set upstream instead of p
220 case "$count" in
221 "") # no upstream
222 upstream="" ;;
223 "0 0") # equal to upstream
224 upstream="|u=" ;;
225 "0 "*) # ahead of upstream
226 upstream="|u+${count#0 }" ;;
227 *" 0") # behind upstream
228 upstream="|u-${count% 0}" ;;
229 *) # diverged from upstream
230 upstream="|u+${count#* }-${count% *}" ;;
231 esac
232 if [[ -n "$count" && -n "$name" ]]; then
233 __git_ps1_upstream_name=$(git rev-parse \
234 --abbrev-ref "$upstream_type" 2>/dev/null)
235 if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
236 upstream="$upstream \${__git_ps1_upstream_name}"
237 else
238 upstream="$upstream ${__git_ps1_upstream_name//\%/%%}"
239 # not needed anymore; keep user's
240 # environment clean
241 unset __git_ps1_upstream_name
242 fi
243 fi
244 fi
245
246}
247
248# Helper function that is meant to be called from __git_ps1. It
249# injects color codes into the appropriate gitstring variables used
250# to build a gitstring. Colored variables are responsible for clearing
251# their own color.
252__git_ps1_colorize_gitstring ()
253{
254 if [[ -n ${ZSH_VERSION-} ]]; then
255 local c_red='%F{red}'
256 local c_green='%F{green}'
257 local c_lblue='%F{blue}'
258 local c_clear='%f'
259 else
260 # Using \001 and \002 around colors is necessary to prevent
261 # issues with command line editing/browsing/completion!
262 local c_red=$'\001\e[31m\002'
263 local c_green=$'\001\e[32m\002'
264 local c_lblue=$'\001\e[1;34m\002'
265 local c_clear=$'\001\e[0m\002'
266 fi
267 local bad_color=$c_red
268 local ok_color=$c_green
269 local flags_color="$c_lblue"
270
271 local branch_color=""
272 if [ $detached = no ]; then
273 branch_color="$ok_color"
274 else
275 branch_color="$bad_color"
276 fi
277 if [ -n "$c" ]; then
278 c="$branch_color$c$c_clear"
279 fi
280 b="$branch_color$b$c_clear"
281
282 if [ -n "$w" ]; then
283 w="$bad_color$w$c_clear"
284 fi
285 if [ -n "$i" ]; then
286 i="$ok_color$i$c_clear"
287 fi
288 if [ -n "$s" ]; then
289 s="$flags_color$s$c_clear"
290 fi
291 if [ -n "$u" ]; then
292 u="$bad_color$u$c_clear"
293 fi
294}
295
296# Helper function to read the first line of a file into a variable.
297# __git_eread requires 2 arguments, the file path and the name of the
298# variable, in that order.
299__git_eread ()
300{
301 test -r "$1" && IFS=$'\r\n' read "$2" <"$1"
302}
303
304# see if a cherry-pick or revert is in progress, if the user has committed a
305# conflict resolution with 'git commit' in the middle of a sequence of picks or
306# reverts then CHERRY_PICK_HEAD/REVERT_HEAD will not exist so we have to read
307# the todo file.
308__git_sequencer_status ()
309{
310 local todo
311 if test -f "$g/CHERRY_PICK_HEAD"
312 then
313 r="|CHERRY-PICKING"
314 return 0;
315 elif test -f "$g/REVERT_HEAD"
316 then
317 r="|REVERTING"
318 return 0;
319 elif __git_eread "$g/sequencer/todo" todo
320 then
321 case "$todo" in
322 p[\ \ ]|pick[\ \ ]*)
323 r="|CHERRY-PICKING"
324 return 0
325 ;;
326 revert[\ \ ]*)
327 r="|REVERTING"
328 return 0
329 ;;
330 esac
331 fi
332 return 1
333}
334
335# __git_ps1 accepts 0 or 1 arguments (i.e., format string)
336# when called from PS1 using command substitution
337# in this mode it prints text to add to bash PS1 prompt (includes branch name)
338#
339# __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
340# in that case it _sets_ PS1. The arguments are parts of a PS1 string.
341# when two arguments are given, the first is prepended and the second appended
342# to the state string when assigned to PS1.
343# The optional third parameter will be used as printf format string to further
344# customize the output of the git-status string.
345# In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
346__git_ps1 ()
347{
348 # preserve exit status
349 local exit=$?
350 local pcmode=no
351 local detached=no
352 local ps1pc_start='\u@\h:\w '
353 local ps1pc_end='\$ '
354 local printf_format=' (%s)'
355
356 case "$#" in
357 2|3) pcmode=yes
358 ps1pc_start="$1"
359 ps1pc_end="$2"
360 printf_format="${3:-$printf_format}"
361 # set PS1 to a plain prompt so that we can
362 # simply return early if the prompt should not
363 # be decorated
364 PS1="$ps1pc_start$ps1pc_end"
365 ;;
366 0|1) printf_format="${1:-$printf_format}"
367 ;;
368 *) return $exit
369 ;;
370 esac
371
372 # ps1_expanded: This variable is set to 'yes' if the shell
373 # subjects the value of PS1 to parameter expansion:
374 #
375 # * bash does unless the promptvars option is disabled
376 # * zsh does not unless the PROMPT_SUBST option is set
377 # * POSIX shells always do
378 #
379 # If the shell would expand the contents of PS1 when drawing
380 # the prompt, a raw ref name must not be included in PS1.
381 # This protects the user from arbitrary code execution via
382 # specially crafted ref names. For example, a ref named
383 # 'refs/heads/$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)' might cause the
384 # shell to execute 'sudo rm -rf /' when the prompt is drawn.
385 #
386 # Instead, the ref name should be placed in a separate global
387 # variable (in the __git_ps1_* namespace to avoid colliding
388 # with the user's environment) and that variable should be
389 # referenced from PS1. For example:
390 #
391 # __git_ps1_foo=$(do_something_to_get_ref_name)
392 # PS1="...stuff...\${__git_ps1_foo}...stuff..."
393 #
394 # If the shell does not expand the contents of PS1, the raw
395 # ref name must be included in PS1.
396 #
397 # The value of this variable is only relevant when in pcmode.
398 #
399 # Assume that the shell follows the POSIX specification and
400 # expands PS1 unless determined otherwise. (This is more
401 # likely to be correct if the user has a non-bash, non-zsh
402 # shell and safer than the alternative if the assumption is
403 # incorrect.)
404 #
405 local ps1_expanded=yes
406 [ -z "${ZSH_VERSION-}" ] || [[ -o PROMPT_SUBST ]] || ps1_expanded=no
407 [ -z "${BASH_VERSION-}" ] || shopt -q promptvars || ps1_expanded=no
408
409 local repo_info rev_parse_exit_code
410 repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
411 --is-bare-repository --is-inside-work-tree \
412 --short HEAD 2>/dev/null)"
413 rev_parse_exit_code="$?"
414
415 if [ -z "$repo_info" ]; then
416 return $exit
417 fi
418
419 local short_sha=""
420 if [ "$rev_parse_exit_code" = "0" ]; then
421 short_sha="${repo_info##*$'\n'}"
422 repo_info="${repo_info%$'\n'*}"
423 fi
424 local inside_worktree="${repo_info##*$'\n'}"
425 repo_info="${repo_info%$'\n'*}"
426 local bare_repo="${repo_info##*$'\n'}"
427 repo_info="${repo_info%$'\n'*}"
428 local inside_gitdir="${repo_info##*$'\n'}"
429 local g="${repo_info%$'\n'*}"
430
431 if [ "true" = "$inside_worktree" ] &&
432 [ -n "${GIT_PS1_HIDE_IF_PWD_IGNORED-}" ] &&
433 [ "$(git config --bool bash.hideIfPwdIgnored)" != "false" ] &&
434 git check-ignore -q .
435 then
436 return $exit
437 fi
438
439 local sparse=""
440 if [ -z "${GIT_PS1_COMPRESSSPARSESTATE-}" ] &&
441 [ -z "${GIT_PS1_OMITSPARSESTATE-}" ] &&
442 [ "$(git config --bool core.sparseCheckout)" = "true" ]; then
443 sparse="|SPARSE"
444 fi
445
446 local r=""
447 local b=""
448 local step=""
449 local total=""
450 if [ -d "$g/rebase-merge" ]; then
451 __git_eread "$g/rebase-merge/head-name" b
452 __git_eread "$g/rebase-merge/msgnum" step
453 __git_eread "$g/rebase-merge/end" total
454 r="|REBASE"
455 else
456 if [ -d "$g/rebase-apply" ]; then
457 __git_eread "$g/rebase-apply/next" step
458 __git_eread "$g/rebase-apply/last" total
459 if [ -f "$g/rebase-apply/rebasing" ]; then
460 __git_eread "$g/rebase-apply/head-name" b
461 r="|REBASE"
462 elif [ -f "$g/rebase-apply/applying" ]; then
463 r="|AM"
464 else
465 r="|AM/REBASE"
466 fi
467 elif [ -f "$g/MERGE_HEAD" ]; then
468 r="|MERGING"
469 elif __git_sequencer_status; then
470 :
471 elif [ -f "$g/BISECT_LOG" ]; then
472 r="|BISECTING"
473 fi
474
475 if [ -n "$b" ]; then
476 :
477 elif [ -h "$g/HEAD" ]; then
478 # symlink symbolic ref
479 b="$(git symbolic-ref HEAD 2>/dev/null)"
480 else
481 local head=""
482 if ! __git_eread "$g/HEAD" head; then
483 return $exit
484 fi
485 # is it a symbolic ref?
486 b="${head#ref: }"
487 if [ "$head" = "$b" ]; then
488 detached=yes
489 b="$(
490 case "${GIT_PS1_DESCRIBE_STYLE-}" in
491 (contains)
492 git describe --contains HEAD ;;
493 (branch)
494 git describe --contains --all HEAD ;;
495 (tag)
496 git describe --tags HEAD ;;
497 (describe)
498 git describe HEAD ;;
499 (* | default)
500 git describe --tags --exact-match HEAD ;;
501 esac 2>/dev/null)" ||
502
503 b="$short_sha..."
504 b="($b)"
505 fi
506 fi
507 fi
508
509 if [ -n "$step" ] && [ -n "$total" ]; then
510 r="$r $step/$total"
511 fi
512
513 local conflict="" # state indicator for unresolved conflicts
514 if [[ "${GIT_PS1_SHOWCONFLICTSTATE}" == "yes" ]] &&
515 [[ $(git ls-files --unmerged 2>/dev/null) ]]; then
516 conflict="|CONFLICT"
517 fi
518
519 local w=""
520 local i=""
521 local s=""
522 local u=""
523 local h=""
524 local c=""
525 local p="" # short version of upstream state indicator
526 local upstream="" # verbose version of upstream state indicator
527
528 if [ "true" = "$inside_gitdir" ]; then
529 if [ "true" = "$bare_repo" ]; then
530 c="BARE:"
531 else
532 b="GIT_DIR!"
533 fi
534 elif [ "true" = "$inside_worktree" ]; then
535 if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
536 [ "$(git config --bool bash.showDirtyState)" != "false" ]
537 then
538 git diff --no-ext-diff --quiet || w="*"
539 git diff --no-ext-diff --cached --quiet || i="+"
540 if [ -z "$short_sha" ] && [ -z "$i" ]; then
541 i="#"
542 fi
543 fi
544 if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
545 git rev-parse --verify --quiet refs/stash >/dev/null
546 then
547 s="$"
548 fi
549
550 if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
551 [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
552 git ls-files --others --exclude-standard --directory --no-empty-directory --error-unmatch -- ':/*' >/dev/null 2>/dev/null
553 then
554 u="%${ZSH_VERSION+%}"
555 fi
556
557 if [ -n "${GIT_PS1_COMPRESSSPARSESTATE-}" ] &&
558 [ "$(git config --bool core.sparseCheckout)" = "true" ]; then
559 h="?"
560 fi
561
562 if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
563 __git_ps1_show_upstream
564 fi
565 fi
566
567 local z="${GIT_PS1_STATESEPARATOR-" "}"
568
569 b=${b##refs/heads/}
570 if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
571 __git_ps1_branch_name=$b
572 b="\${__git_ps1_branch_name}"
573 else
574 # escape % in branch name to avoid prompt expansion issues
575 b="${b//\%/%%}"
576 fi
577
578 if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
579 __git_ps1_colorize_gitstring
580 fi
581
582 local f="$h$w$i$s$u$p"
583 local gitstring="$c$b${f:+$z$f}${sparse}$r${upstream}${conflict}"
584
585 if [ $pcmode = yes ]; then
586 if [ "${__git_printf_supports_v-}" != yes ]; then
587 gitstring=$(printf -- "$printf_format" "$gitstring")
588 else
589 printf -v gitstring -- "$printf_format" "$gitstring"
590 fi
591 PS1="$ps1pc_start$gitstring$ps1pc_end"
592 else
593 printf -- "$printf_format" "$gitstring"
594 fi
595
596 return $exit
597}