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