1 # The git prompt's git commands are read-only and should not interfere with
2 # other processes. This environment variable is equivalent to running with `git
3 # --no-optional-locks`, but falls back gracefully for older versions of git.
4 # See git(1) for and git-status(1) for a description of that flag.
6 # We wrap in a local function instead of exporting the variable directly in
7 # order to avoid interfering with manually-run git commands by the user.
8 function __git_prompt_git() {
9 GIT_OPTIONAL_LOCKS=0 command git "$@"
12 function git_prompt_info() {
13 # If we are on a folder not tracked by git, get out.
14 # Otherwise, check for hide-info at global and local repository level
15 if ! __git_prompt_git rev-parse --git-dir &> /dev/null \
16 || [[ "$(__git_prompt_git config --get oh-my-zsh.hide-info 2>/dev/null)" == 1 ]]; then
21 ref=$(__git_prompt_git symbolic-ref --short HEAD 2> /dev/null) \
22 || ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) \
25 # Use global ZSH_THEME_GIT_SHOW_UPSTREAM=1 for including upstream remote info
27 if (( ${+ZSH_THEME_GIT_SHOW_UPSTREAM} )); then
28 upstream=$(__git_prompt_git rev-parse --abbrev-ref --symbolic-full-name "@{upstream}" 2>/dev/null) \
29 && upstream=" -> ${upstream}"
32 echo "${ZSH_THEME_GIT_PROMPT_PREFIX}${ref:gs/%/%%}${upstream:gs/%/%%}$(parse_git_dirty)${ZSH_THEME_GIT_PROMPT_SUFFIX}"
35 # Checks if working tree is dirty
36 function parse_git_dirty() {
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'
44 case "${GIT_STATUS_IGNORE_SUBMODULES:-}" in
46 # 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}"
54 STATUS=$(__git_prompt_git status ${FLAGS} 2> /dev/null | tail -n 1)
56 if [[ -n $STATUS ]]; then
57 echo "$ZSH_THEME_GIT_PROMPT_DIRTY"
59 echo "$ZSH_THEME_GIT_PROMPT_CLEAN"
63 # Gets the difference between the local and remote branches
64 function git_remote_status() {
65 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 ahead=$(__git_prompt_git rev-list ${hook_com[branch]}@{upstream}..HEAD 2>/dev/null | wc -l)
69 behind=$(__git_prompt_git rev-list HEAD..${hook_com[branch]}@{upstream} 2>/dev/null | wc -l)
71 if [[ $ahead -eq 0 ]] && [[ $behind -eq 0 ]]; then
72 git_remote_status="$ZSH_THEME_GIT_PROMPT_EQUAL_REMOTE"
73 elif [[ $ahead -gt 0 ]] && [[ $behind -eq 0 ]]; then
74 git_remote_status="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE"
75 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 git_remote_status="$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE"
78 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 git_remote_status="$ZSH_THEME_GIT_PROMPT_DIVERGED_REMOTE"
81 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%}"
84 if [[ -n $ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED ]]; then
85 git_remote_status="$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_PREFIX${remote:gs/%/%%}$git_remote_status_detailed$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_SUFFIX"
88 echo $git_remote_status
92 # Outputs the name of the current branch
93 # Usage example: git pull origin $(git_current_branch)
94 # Using '--quiet' with 'symbolic-ref' will not cause a fatal error (128) if
95 # it's not a symbolic ref, but in a Git repo.
96 function git_current_branch() {
98 ref=$(__git_prompt_git symbolic-ref --quiet HEAD 2> /dev/null)
100 if [[ $ret != 0 ]]; then
101 [[ $ret == 128 ]] && return # no git repo.
102 ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) || return
104 echo ${ref#refs/heads/}
108 # Gets the number of commits ahead from remote
109 function git_commits_ahead() {
110 if __git_prompt_git rev-parse --git-dir &>/dev/null; then
111 local commits="$(__git_prompt_git rev-list --count @{upstream}..HEAD 2>/dev/null)"
112 if [[ -n "$commits" && "$commits" != 0 ]]; then
113 echo "$ZSH_THEME_GIT_COMMITS_AHEAD_PREFIX$commits$ZSH_THEME_GIT_COMMITS_AHEAD_SUFFIX"
118 # Gets the number of commits behind remote
119 function git_commits_behind() {
120 if __git_prompt_git rev-parse --git-dir &>/dev/null; then
121 local commits="$(__git_prompt_git rev-list --count HEAD..@{upstream} 2>/dev/null)"
122 if [[ -n "$commits" && "$commits" != 0 ]]; then
123 echo "$ZSH_THEME_GIT_COMMITS_BEHIND_PREFIX$commits$ZSH_THEME_GIT_COMMITS_BEHIND_SUFFIX"
128 # Outputs if current branch is ahead of remote
129 function git_prompt_ahead() {
130 if [[ -n "$(__git_prompt_git rev-list origin/$(git_current_branch)..HEAD 2> /dev/null)" ]]; then
131 echo "$ZSH_THEME_GIT_PROMPT_AHEAD"
135 # Outputs if current branch is behind remote
136 function git_prompt_behind() {
137 if [[ -n "$(__git_prompt_git rev-list HEAD..origin/$(git_current_branch) 2> /dev/null)" ]]; then
138 echo "$ZSH_THEME_GIT_PROMPT_BEHIND"
142 # Outputs if current branch exists on remote or not
143 function git_prompt_remote() {
144 if [[ -n "$(__git_prompt_git show-ref origin/$(git_current_branch) 2> /dev/null)" ]]; then
145 echo "$ZSH_THEME_GIT_PROMPT_REMOTE_EXISTS"
147 echo "$ZSH_THEME_GIT_PROMPT_REMOTE_MISSING"
151 # Formats prompt string for current git commit short SHA
152 function git_prompt_short_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"
157 # Formats prompt string for current git commit long SHA
158 function git_prompt_long_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"
163 function git_prompt_status() {
164 [[ "$(__git_prompt_git config --get oh-my-zsh.hide-status 2>/dev/null)" = 1 ]] && return
166 # Maps a git status prefix to an internal constant
167 # This cannot use the prompt constants, as they may be empty
168 local -A prefix_constant_map
169 prefix_constant_map=(
183 'diverged' 'DIVERGED'
187 # Maps the internal constant to the prompt theme
188 local -A constant_prompt_map
189 constant_prompt_map=(
190 'UNTRACKED' "$ZSH_THEME_GIT_PROMPT_UNTRACKED"
191 'ADDED' "$ZSH_THEME_GIT_PROMPT_ADDED"
192 'MODIFIED' "$ZSH_THEME_GIT_PROMPT_MODIFIED"
193 'RENAMED' "$ZSH_THEME_GIT_PROMPT_RENAMED"
194 'DELETED' "$ZSH_THEME_GIT_PROMPT_DELETED"
195 'UNMERGED' "$ZSH_THEME_GIT_PROMPT_UNMERGED"
196 'AHEAD' "$ZSH_THEME_GIT_PROMPT_AHEAD"
197 'BEHIND' "$ZSH_THEME_GIT_PROMPT_BEHIND"
198 'DIVERGED' "$ZSH_THEME_GIT_PROMPT_DIVERGED"
199 'STASHED' "$ZSH_THEME_GIT_PROMPT_STASHED"
202 # The order that the prompt displays should be added to the prompt
203 local status_constants
205 UNTRACKED ADDED MODIFIED RENAMED DELETED
206 STASHED UNMERGED AHEAD BEHIND DIVERGED
210 status_text="$(__git_prompt_git status --porcelain -b 2> /dev/null)"
212 # Don't continue on a catastrophic failure
213 if [[ $? -eq 128 ]]; then
217 # A lookup table of each git status encountered
218 local -A statuses_seen
220 if __git_prompt_git rev-parse --verify refs/stash &>/dev/null; then
221 statuses_seen[STASHED]=1
225 status_lines=("${(@f)${status_text}}")
227 # If the tracking line exists, get and parse it
228 if [[ "$status_lines[1]" =~ "^## [^ ]+ \[(.*)\]" ]]; then
229 local branch_statuses
230 branch_statuses=("${(@s/,/)match}")
231 for branch_status in $branch_statuses; do
232 if [[ ! $branch_status =~ "(behind|diverged|ahead) ([0-9]+)?" ]]; then
235 local last_parsed_status=$prefix_constant_map[$match[1]]
236 statuses_seen[$last_parsed_status]=$match[2]
240 # For each status prefix, do a regex comparison
241 for status_prefix in ${(k)prefix_constant_map}; do
242 local status_constant="${prefix_constant_map[$status_prefix]}"
243 local status_regex=$'(^|\n)'"$status_prefix"
245 if [[ "$status_text" =~ $status_regex ]]; then
246 statuses_seen[$status_constant]=1
250 # Display the seen statuses in the order specified
252 for status_constant in $status_constants; do
253 if (( ${+statuses_seen[$status_constant]} )); then
254 local next_display=$constant_prompt_map[$status_constant]
255 status_prompt="$next_display$status_prompt"
262 # Outputs the name of the current user
263 # Usage example: $(git_current_user_name)
264 function git_current_user_name() {
265 __git_prompt_git config user.name 2>/dev/null
268 # Outputs the email of the current user
269 # Usage example: $(git_current_user_email)
270 function git_current_user_email() {
271 __git_prompt_git config user.email 2>/dev/null
274 # Output the name of the root directory of the git repository
275 # Usage example: $(git_repo_name)
276 function git_repo_name() {
278 if repo_path="$(__git_prompt_git rev-parse --show-toplevel 2>/dev/null)" && [[ -n "$repo_path" ]]; then