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