git.zsh 10 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
# The git prompt's git commands are read-only and should not interfere with
# other processes. This environment variable is equivalent to running with `git
# --no-optional-locks`, but falls back gracefully for older versions of git.
# See git(1) for and git-status(1) for a description of that flag.
#
# We wrap in a local function instead of exporting the variable directly in
# order to avoid interfering with manually-run git commands by the user.
function __git_prompt_git() {
  GIT_OPTIONAL_LOCKS=0 command git "$@"
}

12
function git_prompt_info() {
13
14
15
16
17
18
19
  # If we are on a folder not tracked by git, get out.
  # Otherwise, check for hide-info at global and local repository level
  if ! __git_prompt_git rev-parse --git-dir &> /dev/null \
     || [[ "$(__git_prompt_git config --get oh-my-zsh.hide-info 2>/dev/null)" == 1 ]]; then
    return 0
  fi

20
  local ref
21
22
23
  ref=$(__git_prompt_git symbolic-ref --short HEAD 2> /dev/null) \
  || ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) \
  || return 0
24

25
26
27
28
29
  # Use global ZSH_THEME_GIT_SHOW_UPSTREAM=1 for including upstream remote info
  local upstream
  if (( ${+ZSH_THEME_GIT_SHOW_UPSTREAM} )); then
    upstream=$(__git_prompt_git rev-parse --abbrev-ref --symbolic-full-name "@{upstream}" 2>/dev/null) \
    && upstream=" -> ${upstream}"
30
  fi
31
32

  echo "${ZSH_THEME_GIT_PROMPT_PREFIX}${ref}${upstream}$(parse_git_dirty)${ZSH_THEME_GIT_PROMPT_SUFFIX}"
33
}
34

35
# Checks if working tree is dirty
36
function parse_git_dirty() {
37
  local STATUS
38
  local -a FLAGS
39
  FLAGS=('--porcelain')
40
  if [[ "$(__git_prompt_git config --get oh-my-zsh.hide-dirty)" != "1" ]]; then
41
    if [[ "${DISABLE_UNTRACKED_FILES_DIRTY:-}" == "true" ]]; then
42
      FLAGS+='--untracked-files=no'
43
    fi
44
    case "${GIT_STATUS_IGNORE_SUBMODULES:-}" in
45
      git)
46
47
48
        # let git decide (this respects per-repo config in .gitmodules)
        ;;
      *)
49
        # if unset: ignore dirty submodules
50
        # other values are passed to --ignore-submodules
51
        FLAGS+="--ignore-submodules=${GIT_STATUS_IGNORE_SUBMODULES:-dirty}"
52
53
        ;;
    esac
54
    STATUS=$(__git_prompt_git status ${FLAGS} 2> /dev/null | tail -n1)
55
56
57
  fi
  if [[ -n $STATUS ]]; then
    echo "$ZSH_THEME_GIT_PROMPT_DIRTY"
Felipe Contreras's avatar
Felipe Contreras committed
58
59
  else
    echo "$ZSH_THEME_GIT_PROMPT_CLEAN"
60
  fi
61
}
62

63
64
65
# Gets the difference between the local and remote branches
function git_remote_status() {
    local remote ahead behind git_remote_status git_remote_status_detailed
66
    remote=${$(__git_prompt_git rev-parse --verify ${hook_com[branch]}@{upstream} --symbolic-full-name 2>/dev/null)/refs\/remotes\/}
67
    if [[ -n ${remote} ]]; then
68
69
        ahead=$(__git_prompt_git rev-list ${hook_com[branch]}@{upstream}..HEAD 2>/dev/null | wc -l)
        behind=$(__git_prompt_git rev-list HEAD..${hook_com[branch]}@{upstream} 2>/dev/null | wc -l)
70

71
72
73
        if [[ $ahead -eq 0 ]] && [[ $behind -eq 0 ]]; then
            git_remote_status="$ZSH_THEME_GIT_PROMPT_EQUAL_REMOTE"
        elif [[ $ahead -gt 0 ]] && [[ $behind -eq 0 ]]; then
74
75
            git_remote_status="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE"
            git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE$((ahead))%{$reset_color%}"
76
        elif [[ $behind -gt 0 ]] && [[ $ahead -eq 0 ]]; then
77
78
            git_remote_status="$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE"
            git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE$((behind))%{$reset_color%}"
79
        elif [[ $ahead -gt 0 ]] && [[ $behind -gt 0 ]]; then
80
81
            git_remote_status="$ZSH_THEME_GIT_PROMPT_DIVERGED_REMOTE"
            git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE$((ahead))%{$reset_color%}$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE$((behind))%{$reset_color%}"
82
        fi
83

84
        if [[ -n $ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED ]]; then
85
86
87
88
            git_remote_status="$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_PREFIX$remote$git_remote_status_detailed$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_SUFFIX"
        fi

        echo $git_remote_status
89
90
91
    fi
}

92
93
94
95
96
97
# Outputs the name of the current branch
# Usage example: git pull origin $(git_current_branch)
# Using '--quiet' with 'symbolic-ref' will not cause a fatal error (128) if
# it's not a symbolic ref, but in a Git repo.
function git_current_branch() {
  local ref
98
  ref=$(__git_prompt_git symbolic-ref --quiet HEAD 2> /dev/null)
99
100
101
  local ret=$?
  if [[ $ret != 0 ]]; then
    [[ $ret == 128 ]] && return  # no git repo.
102
    ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) || return
103
104
105
106
107
  fi
  echo ${ref#refs/heads/}
}


108
109
# Gets the number of commits ahead from remote
function git_commits_ahead() {
110
111
  if __git_prompt_git rev-parse --git-dir &>/dev/null; then
    local commits="$(__git_prompt_git rev-list --count @{upstream}..HEAD 2>/dev/null)"
112
    if [[ -n "$commits" && "$commits" != 0 ]]; then
113
114
      echo "$ZSH_THEME_GIT_COMMITS_AHEAD_PREFIX$commits$ZSH_THEME_GIT_COMMITS_AHEAD_SUFFIX"
    fi
115
116
117
  fi
}

118
119
# Gets the number of commits behind remote
function git_commits_behind() {
120
121
  if __git_prompt_git rev-parse --git-dir &>/dev/null; then
    local commits="$(__git_prompt_git rev-list --count HEAD..@{upstream} 2>/dev/null)"
122
    if [[ -n "$commits" && "$commits" != 0 ]]; then
123
124
      echo "$ZSH_THEME_GIT_COMMITS_BEHIND_PREFIX$commits$ZSH_THEME_GIT_COMMITS_BEHIND_SUFFIX"
    fi
125
126
127
  fi
}

128
129
# Outputs if current branch is ahead of remote
function git_prompt_ahead() {
130
  if [[ -n "$(__git_prompt_git rev-list origin/$(git_current_branch)..HEAD 2> /dev/null)" ]]; then
131
132
133
134
135
136
    echo "$ZSH_THEME_GIT_PROMPT_AHEAD"
  fi
}

# Outputs if current branch is behind remote
function git_prompt_behind() {
137
  if [[ -n "$(__git_prompt_git rev-list HEAD..origin/$(git_current_branch) 2> /dev/null)" ]]; then
138
139
140
141
142
143
    echo "$ZSH_THEME_GIT_PROMPT_BEHIND"
  fi
}

# Outputs if current branch exists on remote or not
function git_prompt_remote() {
144
  if [[ -n "$(__git_prompt_git show-ref origin/$(git_current_branch) 2> /dev/null)" ]]; then
145
146
147
148
149
150
    echo "$ZSH_THEME_GIT_PROMPT_REMOTE_EXISTS"
  else
    echo "$ZSH_THEME_GIT_PROMPT_REMOTE_MISSING"
  fi
}

151
152
# Formats prompt string for current git commit short SHA
function git_prompt_short_sha() {
153
  local SHA
154
  SHA=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) && echo "$ZSH_THEME_GIT_PROMPT_SHA_BEFORE$SHA$ZSH_THEME_GIT_PROMPT_SHA_AFTER"
155
156
157
158
}

# Formats prompt string for current git commit long SHA
function git_prompt_long_sha() {
159
  local SHA
160
  SHA=$(__git_prompt_git rev-parse HEAD 2> /dev/null) && echo "$ZSH_THEME_GIT_PROMPT_SHA_BEFORE$SHA$ZSH_THEME_GIT_PROMPT_SHA_AFTER"
161
162
}

163
function git_prompt_status() {
164
165
  [[ "$(__git_prompt_git config --get oh-my-zsh.hide-status 2>/dev/null)" = 1 ]] && return

166
167
  # Maps a git status prefix to an internal constant
  # This cannot use the prompt constants, as they may be empty
168
169
170
  local -A prefix_constant_map
  prefix_constant_map=(
    '\?\? '     'UNTRACKED'
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
    'A  '       'ADDED'
    'M  '       'ADDED'
    'MM '       'ADDED'
    ' M '       'MODIFIED'
    'AM '       'MODIFIED'
    ' T '       'MODIFIED'
    'R  '       'RENAMED'
    ' D '       'DELETED'
    'D  '       'DELETED'
    'UU '       'UNMERGED'
    'ahead'     'AHEAD'
    'behind'    'BEHIND'
    'diverged'  'DIVERGED'
    'stashed'   'STASHED'
  )

  # Maps the internal constant to the prompt theme
188
189
  local -A constant_prompt_map
  constant_prompt_map=(
190
191
192
193
194
195
196
197
198
199
200
201
202
    'UNTRACKED' "$ZSH_THEME_GIT_PROMPT_UNTRACKED"
    'ADDED'     "$ZSH_THEME_GIT_PROMPT_ADDED"
    'MODIFIED'  "$ZSH_THEME_GIT_PROMPT_MODIFIED"
    'RENAMED'   "$ZSH_THEME_GIT_PROMPT_RENAMED"
    'DELETED'   "$ZSH_THEME_GIT_PROMPT_DELETED"
    'UNMERGED'  "$ZSH_THEME_GIT_PROMPT_UNMERGED"
    'AHEAD'     "$ZSH_THEME_GIT_PROMPT_AHEAD"
    'BEHIND'    "$ZSH_THEME_GIT_PROMPT_BEHIND"
    'DIVERGED'  "$ZSH_THEME_GIT_PROMPT_DIVERGED"
    'STASHED'   "$ZSH_THEME_GIT_PROMPT_STASHED"
  )

  # The order that the prompt displays should be added to the prompt
203
204
205
206
207
  local status_constants
  status_constants=(
    UNTRACKED ADDED MODIFIED RENAMED DELETED
    STASHED UNMERGED AHEAD BEHIND DIVERGED
  )
208

209
  local status_text="$(__git_prompt_git status --porcelain -b 2> /dev/null)"
210
211
212
213

  # Don't continue on a catastrophic failure
  if [[ $? -eq 128 ]]; then
    return 1
214
  fi
215

216
217
218
219
220
  # A lookup table of each git status encountered
  local -A statuses_seen

  if __git_prompt_git rev-parse --verify refs/stash &>/dev/null; then
    statuses_seen[STASHED]=1
221
  fi
222

223
224
  local status_lines
  status_lines=("${(@f)${status_text}}")
225
226

  # If the tracking line exists, get and parse it
227
228
229
  if [[ "$status_lines[1]" =~ "^## [^ ]+ \[(.*)\]" ]]; then
    local branch_statuses
    branch_statuses=("${(@s/,/)match}")
230
231
232
233
234
235
236
    for branch_status in $branch_statuses; do
      if [[ ! $branch_status =~ "(behind|diverged|ahead) ([0-9]+)?" ]]; then
        continue
      fi
      local last_parsed_status=$prefix_constant_map[$match[1]]
      statuses_seen[$last_parsed_status]=$match[2]
    done
237
  fi
238

239
240
241
  # For each status prefix, do a regex comparison
  for status_prefix in ${(k)prefix_constant_map}; do
    local status_constant="${prefix_constant_map[$status_prefix]}"
242
    local status_regex=$'(^|\n)'"$status_prefix"
243

244
245
    if [[ "$status_text" =~ $status_regex ]]; then
      statuses_seen[$status_constant]=1
246
247
248
    fi
  done

249
250
  # Display the seen statuses in the order specified
  local status_prompt
251
  for status_constant in $status_constants; do
252
    if (( ${+statuses_seen[$status_constant]} )); then
253
254
255
256
257
258
      local next_display=$constant_prompt_map[$status_constant]
      status_prompt="$next_display$status_prompt"
    fi
  done

  echo $status_prompt
259
}
260

261
262
263
# Outputs the name of the current user
# Usage example: $(git_current_user_name)
function git_current_user_name() {
264
  __git_prompt_git config user.name 2>/dev/null
265
266
267
268
269
}

# Outputs the email of the current user
# Usage example: $(git_current_user_email)
function git_current_user_email() {
270
  __git_prompt_git config user.email 2>/dev/null
271
}
272
273
274
275
276

# Output the name of the root directory of the git repository
# Usage example: $(git_repo_name)
function git_repo_name() {
  local repo_path
277
  if repo_path="$(__git_prompt_git rev-parse --show-toplevel 2>/dev/null)" && [[ -n "$repo_path" ]]; then
278
279
280
    echo ${repo_path:t}
  fi
}