Andrew's git - gitweb.git/blob - 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# 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# 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:
  77#
  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
  82#
  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.
  87
  88# check whether printf supports -v
  89__git_printf_supports_v=
  90printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
  91
  92# stores the divergence from upstream in $p
  93# used by GIT_PS1_SHOWUPSTREAM
  94__git_ps1_show_upstream ()
  95{
  96        local key value
  97        local svn_remote svn_url_pattern count n
  98        local upstream=git legacy="" verbose="" name=""
  99
 100        svn_remote=()
 101        # get some config options from git-config
 102        local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
 103        while read -r key value; do
 104                case "$key" in
 105                bash.showupstream)
 106                        GIT_PS1_SHOWUPSTREAM="$value"
 107                        if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
 108                                p=""
 109                                return
 110                        fi
 111                        ;;
 112                svn-remote.*.url)
 113                        svn_remote[$((${#svn_remote[@]} + 1))]="$value"
 114                        svn_url_pattern="$svn_url_pattern\\|$value"
 115                        upstream=svn+git # default upstream is SVN if available, else git
 116                        ;;
 117                esac
 118        done <<< "$output"
 119
 120        # parse configuration values
 121        for option in ${GIT_PS1_SHOWUPSTREAM}; do
 122                case "$option" in
 123                git|svn) upstream="$option" ;;
 124                verbose) verbose=1 ;;
 125                legacy)  legacy=1  ;;
 126                name)    name=1 ;;
 127                esac
 128        done
 129
 130        # Find our upstream
 131        case "$upstream" in
 132        git)    upstream="@{upstream}" ;;
 133        svn*)
 134                # get the upstream from the "git-svn-id: ..." in a commit message
 135                # (git-svn uses essentially the same procedure internally)
 136                local -a svn_upstream
 137                svn_upstream=($(git log --first-parent -1 \
 138                                        --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
 139                if [[ 0 -ne ${#svn_upstream[@]} ]]; then
 140                        svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
 141                        svn_upstream=${svn_upstream%@*}
 142                        local n_stop="${#svn_remote[@]}"
 143                        for ((n=1; n <= n_stop; n++)); do
 144                                svn_upstream=${svn_upstream#${svn_remote[$n]}}
 145                        done
 146
 147                        if [[ -z "$svn_upstream" ]]; then
 148                                # default branch name for checkouts with no layout:
 149                                upstream=${GIT_SVN_ID:-git-svn}
 150                        else
 151                                upstream=${svn_upstream#/}
 152                        fi
 153                elif [[ "svn+git" = "$upstream" ]]; then
 154                        upstream="@{upstream}"
 155                fi
 156                ;;
 157        esac
 158
 159        # Find how many commits we are ahead/behind our upstream
 160        if [[ -z "$legacy" ]]; then
 161                count="$(git rev-list --count --left-right \
 162                                "$upstream"...HEAD 2>/dev/null)"
 163        else
 164                # produce equivalent output to --count for older versions of git
 165                local commits
 166                if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)"
 167                then
 168                        local commit behind=0 ahead=0
 169                        for commit in $commits
 170                        do
 171                                case "$commit" in
 172                                "<"*) ((behind++)) ;;
 173                                *)    ((ahead++))  ;;
 174                                esac
 175                        done
 176                        count="$behind  $ahead"
 177                else
 178                        count=""
 179                fi
 180        fi
 181
 182        # calculate the result
 183        if [[ -z "$verbose" ]]; then
 184                case "$count" in
 185                "") # no upstream
 186                        p="" ;;
 187                "0      0") # equal to upstream
 188                        p="=" ;;
 189                "0      "*) # ahead of upstream
 190                        p=">" ;;
 191                *"      0") # behind upstream
 192                        p="<" ;;
 193                *)          # diverged from upstream
 194                        p="<>" ;;
 195                esac
 196        else
 197                case "$count" in
 198                "") # no upstream
 199                        p="" ;;
 200                "0      0") # equal to upstream
 201                        p=" u=" ;;
 202                "0      "*) # ahead of upstream
 203                        p=" u+${count#0 }" ;;
 204                *"      0") # behind upstream
 205                        p=" u-${count%  0}" ;;
 206                *)          # diverged from upstream
 207                        p=" u+${count#* }-${count%      *}" ;;
 208                esac
 209                if [[ -n "$count" && -n "$name" ]]; then
 210                        p="$p $(git rev-parse --abbrev-ref "$upstream" 2>/dev/null)"
 211                fi
 212        fi
 213
 214}
 215
 216# Helper function that is meant to be called from __git_ps1.  It
 217# injects color codes into the appropriate gitstring variables used
 218# to build a gitstring.
 219__git_ps1_colorize_gitstring ()
 220{
 221        if [[ -n ${ZSH_VERSION-} ]]; then
 222                local c_red='%F{red}'
 223                local c_green='%F{green}'
 224                local c_lblue='%F{blue}'
 225                local c_clear='%f'
 226        else
 227                # Using \[ and \] around colors is necessary to prevent
 228                # issues with command line editing/browsing/completion!
 229                local c_red='\[\e[31m\]'
 230                local c_green='\[\e[32m\]'
 231                local c_lblue='\[\e[1;34m\]'
 232                local c_clear='\[\e[0m\]'
 233        fi
 234        local bad_color=$c_red
 235        local ok_color=$c_green
 236        local flags_color="$c_lblue"
 237
 238        local branch_color=""
 239        if [ $detached = no ]; then
 240                branch_color="$ok_color"
 241        else
 242                branch_color="$bad_color"
 243        fi
 244        c="$branch_color$c"
 245
 246        z="$c_clear$z"
 247        if [ "$w" = "*" ]; then
 248                w="$bad_color$w"
 249        fi
 250        if [ -n "$i" ]; then
 251                i="$ok_color$i"
 252        fi
 253        if [ -n "$s" ]; then
 254                s="$flags_color$s"
 255        fi
 256        if [ -n "$u" ]; then
 257                u="$bad_color$u"
 258        fi
 259        r="$c_clear$r"
 260}
 261
 262# __git_ps1 accepts 0 or 1 arguments (i.e., format string)
 263# when called from PS1 using command substitution
 264# in this mode it prints text to add to bash PS1 prompt (includes branch name)
 265#
 266# __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
 267# in that case it _sets_ PS1. The arguments are parts of a PS1 string.
 268# when two arguments are given, the first is prepended and the second appended
 269# to the state string when assigned to PS1.
 270# The optional third parameter will be used as printf format string to further
 271# customize the output of the git-status string.
 272# In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
 273__git_ps1 ()
 274{
 275        local pcmode=no
 276        local detached=no
 277        local ps1pc_start='\u@\h:\w '
 278        local ps1pc_end='\$ '
 279        local printf_format=' (%s)'
 280
 281        case "$#" in
 282                2|3)    pcmode=yes
 283                        ps1pc_start="$1"
 284                        ps1pc_end="$2"
 285                        printf_format="${3:-$printf_format}"
 286                ;;
 287                0|1)    printf_format="${1:-$printf_format}"
 288                ;;
 289                *)      return
 290                ;;
 291        esac
 292
 293        local repo_info rev_parse_exit_code
 294        repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
 295                --is-bare-repository --is-inside-work-tree \
 296                --short HEAD 2>/dev/null)"
 297        rev_parse_exit_code="$?"
 298
 299        if [ -z "$repo_info" ]; then
 300                if [ $pcmode = yes ]; then
 301                        #In PC mode PS1 always needs to be set
 302                        PS1="$ps1pc_start$ps1pc_end"
 303                fi
 304                return
 305        fi
 306
 307        local short_sha
 308        if [ "$rev_parse_exit_code" = "0" ]; then
 309                short_sha="${repo_info##*$'\n'}"
 310                repo_info="${repo_info%$'\n'*}"
 311        fi
 312        local inside_worktree="${repo_info##*$'\n'}"
 313        repo_info="${repo_info%$'\n'*}"
 314        local bare_repo="${repo_info##*$'\n'}"
 315        repo_info="${repo_info%$'\n'*}"
 316        local inside_gitdir="${repo_info##*$'\n'}"
 317        local g="${repo_info%$'\n'*}"
 318
 319        local r=""
 320        local b=""
 321        local step=""
 322        local total=""
 323        if [ -d "$g/rebase-merge" ]; then
 324                read b 2>/dev/null <"$g/rebase-merge/head-name"
 325                read step 2>/dev/null <"$g/rebase-merge/msgnum"
 326                read total 2>/dev/null <"$g/rebase-merge/end"
 327                if [ -f "$g/rebase-merge/interactive" ]; then
 328                        r="|REBASE-i"
 329                else
 330                        r="|REBASE-m"
 331                fi
 332        else
 333                if [ -d "$g/rebase-apply" ]; then
 334                        read step 2>/dev/null <"$g/rebase-apply/next"
 335                        read total 2>/dev/null <"$g/rebase-apply/last"
 336                        if [ -f "$g/rebase-apply/rebasing" ]; then
 337                                read b 2>/dev/null <"$g/rebase-apply/head-name"
 338                                r="|REBASE"
 339                        elif [ -f "$g/rebase-apply/applying" ]; then
 340                                r="|AM"
 341                        else
 342                                r="|AM/REBASE"
 343                        fi
 344                elif [ -f "$g/MERGE_HEAD" ]; then
 345                        r="|MERGING"
 346                elif [ -f "$g/CHERRY_PICK_HEAD" ]; then
 347                        r="|CHERRY-PICKING"
 348                elif [ -f "$g/REVERT_HEAD" ]; then
 349                        r="|REVERTING"
 350                elif [ -f "$g/BISECT_LOG" ]; then
 351                        r="|BISECTING"
 352                fi
 353
 354                if [ -n "$b" ]; then
 355                        :
 356                elif [ -h "$g/HEAD" ]; then
 357                        # symlink symbolic ref
 358                        b="$(git symbolic-ref HEAD 2>/dev/null)"
 359                else
 360                        local head=""
 361                        if ! read head 2>/dev/null <"$g/HEAD"; then
 362                                if [ $pcmode = yes ]; then
 363                                        PS1="$ps1pc_start$ps1pc_end"
 364                                fi
 365                                return
 366                        fi
 367                        # is it a symbolic ref?
 368                        b="${head#ref: }"
 369                        if [ "$head" = "$b" ]; then
 370                                detached=yes
 371                                b="$(
 372                                case "${GIT_PS1_DESCRIBE_STYLE-}" in
 373                                (contains)
 374                                        git describe --contains HEAD ;;
 375                                (branch)
 376                                        git describe --contains --all HEAD ;;
 377                                (describe)
 378                                        git describe HEAD ;;
 379                                (* | default)
 380                                        git describe --tags --exact-match HEAD ;;
 381                                esac 2>/dev/null)" ||
 382
 383                                b="$short_sha..."
 384                                b="($b)"
 385                        fi
 386                fi
 387        fi
 388
 389        if [ -n "$step" ] && [ -n "$total" ]; then
 390                r="$r $step/$total"
 391        fi
 392
 393        local w=""
 394        local i=""
 395        local s=""
 396        local u=""
 397        local c=""
 398        local p=""
 399
 400        if [ "true" = "$inside_gitdir" ]; then
 401                if [ "true" = "$bare_repo" ]; then
 402                        c="BARE:"
 403                else
 404                        b="GIT_DIR!"
 405                fi
 406        elif [ "true" = "$inside_worktree" ]; then
 407                if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
 408                   [ "$(git config --bool bash.showDirtyState)" != "false" ]
 409                then
 410                        git diff --no-ext-diff --quiet --exit-code || w="*"
 411                        if [ -n "$short_sha" ]; then
 412                                git diff-index --cached --quiet HEAD -- || i="+"
 413                        else
 414                                i="#"
 415                        fi
 416                fi
 417                if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
 418                   [ -r "$g/refs/stash" ]; then
 419                        s="$"
 420                fi
 421
 422                if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
 423                   [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
 424                   git ls-files --others --exclude-standard --error-unmatch -- '*' >/dev/null 2>/dev/null
 425                then
 426                        u="%${ZSH_VERSION+%}"
 427                fi
 428
 429                if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
 430                        __git_ps1_show_upstream
 431                fi
 432        fi
 433
 434        local z="${GIT_PS1_STATESEPARATOR-" "}"
 435
 436        # NO color option unless in PROMPT_COMMAND mode
 437        if [ $pcmode = yes ] && [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
 438                __git_ps1_colorize_gitstring
 439        fi
 440
 441        local f="$w$i$s$u"
 442        local gitstring="$c${b##refs/heads/}${f:+$z$f}$r$p"
 443
 444        if [ $pcmode = yes ]; then
 445                if [ "${__git_printf_supports_v-}" != yes ]; then
 446                        gitstring=$(printf -- "$printf_format" "$gitstring")
 447                else
 448                        printf -v gitstring -- "$printf_format" "$gitstring"
 449                fi
 450                PS1="$ps1pc_start$gitstring$ps1pc_end"
 451        else
 452                printf -- "$printf_format" "$gitstring"
 453        fi
 454}