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