git.zsh 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267
  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.
  5. #
  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 "$@"
  10. }
  11. # Outputs current branch info in prompt format
  12. function git_prompt_info() {
  13. local ref
  14. if [[ "$(__git_prompt_git config --get oh-my-zsh.hide-status 2>/dev/null)" != "1" ]]; then
  15. ref=$(__git_prompt_git symbolic-ref HEAD 2> /dev/null) || \
  16. ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) || return 0
  17. echo "$ZSH_THEME_GIT_PROMPT_PREFIX${ref#refs/heads/}$(parse_git_dirty)$ZSH_THEME_GIT_PROMPT_SUFFIX"
  18. fi
  19. }
  20. # Checks if working tree is dirty
  21. function parse_git_dirty() {
  22. local STATUS
  23. local -a FLAGS
  24. FLAGS=('--porcelain')
  25. if [[ "$(__git_prompt_git config --get oh-my-zsh.hide-dirty)" != "1" ]]; then
  26. if [[ "${DISABLE_UNTRACKED_FILES_DIRTY:-}" == "true" ]]; then
  27. FLAGS+='--untracked-files=no'
  28. fi
  29. case "${GIT_STATUS_IGNORE_SUBMODULES:-}" in
  30. git)
  31. # let git decide (this respects per-repo config in .gitmodules)
  32. ;;
  33. *)
  34. # if unset: ignore dirty submodules
  35. # other values are passed to --ignore-submodules
  36. FLAGS+="--ignore-submodules=${GIT_STATUS_IGNORE_SUBMODULES:-dirty}"
  37. ;;
  38. esac
  39. STATUS=$(__git_prompt_git status ${FLAGS} 2> /dev/null | tail -n1)
  40. fi
  41. if [[ -n $STATUS ]]; then
  42. echo "$ZSH_THEME_GIT_PROMPT_DIRTY"
  43. else
  44. echo "$ZSH_THEME_GIT_PROMPT_CLEAN"
  45. fi
  46. }
  47. # Gets the difference between the local and remote branches
  48. function git_remote_status() {
  49. local remote ahead behind git_remote_status git_remote_status_detailed
  50. remote=${$(__git_prompt_git rev-parse --verify ${hook_com[branch]}@{upstream} --symbolic-full-name 2>/dev/null)/refs\/remotes\/}
  51. if [[ -n ${remote} ]]; then
  52. ahead=$(__git_prompt_git rev-list ${hook_com[branch]}@{upstream}..HEAD 2>/dev/null | wc -l)
  53. behind=$(__git_prompt_git rev-list HEAD..${hook_com[branch]}@{upstream} 2>/dev/null | wc -l)
  54. if [[ $ahead -eq 0 ]] && [[ $behind -eq 0 ]]; then
  55. git_remote_status="$ZSH_THEME_GIT_PROMPT_EQUAL_REMOTE"
  56. elif [[ $ahead -gt 0 ]] && [[ $behind -eq 0 ]]; then
  57. git_remote_status="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE"
  58. git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_AHEAD_REMOTE$((ahead))%{$reset_color%}"
  59. elif [[ $behind -gt 0 ]] && [[ $ahead -eq 0 ]]; then
  60. git_remote_status="$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE"
  61. git_remote_status_detailed="$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE_COLOR$ZSH_THEME_GIT_PROMPT_BEHIND_REMOTE$((behind))%{$reset_color%}"
  62. elif [[ $ahead -gt 0 ]] && [[ $behind -gt 0 ]]; then
  63. git_remote_status="$ZSH_THEME_GIT_PROMPT_DIVERGED_REMOTE"
  64. 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%}"
  65. fi
  66. if [[ -n $ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_DETAILED ]]; then
  67. git_remote_status="$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_PREFIX$remote$git_remote_status_detailed$ZSH_THEME_GIT_PROMPT_REMOTE_STATUS_SUFFIX"
  68. fi
  69. echo $git_remote_status
  70. fi
  71. }
  72. # Outputs the name of the current branch
  73. # Usage example: git pull origin $(git_current_branch)
  74. # Using '--quiet' with 'symbolic-ref' will not cause a fatal error (128) if
  75. # it's not a symbolic ref, but in a Git repo.
  76. function git_current_branch() {
  77. local ref
  78. ref=$(__git_prompt_git symbolic-ref --quiet HEAD 2> /dev/null)
  79. local ret=$?
  80. if [[ $ret != 0 ]]; then
  81. [[ $ret == 128 ]] && return # no git repo.
  82. ref=$(__git_prompt_git rev-parse --short HEAD 2> /dev/null) || return
  83. fi
  84. echo ${ref#refs/heads/}
  85. }
  86. # Gets the number of commits ahead from remote
  87. function git_commits_ahead() {
  88. if __git_prompt_git rev-parse --git-dir &>/dev/null; then
  89. local commits="$(__git_prompt_git rev-list --count @{upstream}..HEAD 2>/dev/null)"
  90. if [[ -n "$commits" && "$commits" != 0 ]]; then
  91. echo "$ZSH_THEME_GIT_COMMITS_AHEAD_PREFIX$commits$ZSH_THEME_GIT_COMMITS_AHEAD_SUFFIX"
  92. fi
  93. fi
  94. }
  95. # Gets the number of commits behind remote
  96. function git_commits_behind() {
  97. if __git_prompt_git rev-parse --git-dir &>/dev/null; then
  98. local commits="$(__git_prompt_git rev-list --count HEAD..@{upstream} 2>/dev/null)"
  99. if [[ -n "$commits" && "$commits" != 0 ]]; then
  100. echo "$ZSH_THEME_GIT_COMMITS_BEHIND_PREFIX$commits$ZSH_THEME_GIT_COMMITS_BEHIND_SUFFIX"
  101. fi
  102. fi
  103. }
  104. # Outputs if current branch is ahead of remote
  105. function git_prompt_ahead() {
  106. if [[ -n "$(__git_prompt_git rev-list origin/$(git_current_branch)..HEAD 2> /dev/null)" ]]; then
  107. echo "$ZSH_THEME_GIT_PROMPT_AHEAD"
  108. fi
  109. }
  110. # Outputs if current branch is behind remote
  111. function git_prompt_behind() {
  112. if [[ -n "$(__git_prompt_git rev-list HEAD..origin/$(git_current_branch) 2> /dev/null)" ]]; then
  113. echo "$ZSH_THEME_GIT_PROMPT_BEHIND"
  114. fi
  115. }
  116. # Outputs if current branch exists on remote or not
  117. function git_prompt_remote() {
  118. if [[ -n "$(__git_prompt_git show-ref origin/$(git_current_branch) 2> /dev/null)" ]]; then
  119. echo "$ZSH_THEME_GIT_PROMPT_REMOTE_EXISTS"
  120. else
  121. echo "$ZSH_THEME_GIT_PROMPT_REMOTE_MISSING"
  122. fi
  123. }
  124. # Formats prompt string for current git commit short SHA
  125. function git_prompt_short_sha() {
  126. local SHA
  127. 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"
  128. }
  129. # Formats prompt string for current git commit long SHA
  130. function git_prompt_long_sha() {
  131. local SHA
  132. SHA=$(__git_prompt_git rev-parse HEAD 2> /dev/null) && echo "$ZSH_THEME_GIT_PROMPT_SHA_BEFORE$SHA$ZSH_THEME_GIT_PROMPT_SHA_AFTER"
  133. }
  134. function git_prompt_status() {
  135. [[ "$(__git_prompt_git config --get oh-my-zsh.hide-status 2>/dev/null)" = 1 ]] && return
  136. # Maps a git status prefix to an internal constant
  137. # This cannot use the prompt constants, as they may be empty
  138. local -A prefix_constant_map
  139. prefix_constant_map=(
  140. '\?\? ' 'UNTRACKED'
  141. 'A ' 'ADDED'
  142. 'M ' 'ADDED'
  143. 'MM ' 'ADDED'
  144. ' M ' 'MODIFIED'
  145. 'AM ' 'MODIFIED'
  146. ' T ' 'MODIFIED'
  147. 'R ' 'RENAMED'
  148. ' D ' 'DELETED'
  149. 'D ' 'DELETED'
  150. 'UU ' 'UNMERGED'
  151. 'ahead' 'AHEAD'
  152. 'behind' 'BEHIND'
  153. 'diverged' 'DIVERGED'
  154. 'stashed' 'STASHED'
  155. )
  156. # Maps the internal constant to the prompt theme
  157. local -A constant_prompt_map
  158. constant_prompt_map=(
  159. 'UNTRACKED' "$ZSH_THEME_GIT_PROMPT_UNTRACKED"
  160. 'ADDED' "$ZSH_THEME_GIT_PROMPT_ADDED"
  161. 'MODIFIED' "$ZSH_THEME_GIT_PROMPT_MODIFIED"
  162. 'RENAMED' "$ZSH_THEME_GIT_PROMPT_RENAMED"
  163. 'DELETED' "$ZSH_THEME_GIT_PROMPT_DELETED"
  164. 'UNMERGED' "$ZSH_THEME_GIT_PROMPT_UNMERGED"
  165. 'AHEAD' "$ZSH_THEME_GIT_PROMPT_AHEAD"
  166. 'BEHIND' "$ZSH_THEME_GIT_PROMPT_BEHIND"
  167. 'DIVERGED' "$ZSH_THEME_GIT_PROMPT_DIVERGED"
  168. 'STASHED' "$ZSH_THEME_GIT_PROMPT_STASHED"
  169. )
  170. # The order that the prompt displays should be added to the prompt
  171. local status_constants
  172. status_constants=(
  173. UNTRACKED ADDED MODIFIED RENAMED DELETED
  174. STASHED UNMERGED AHEAD BEHIND DIVERGED
  175. )
  176. local status_text="$(__git_prompt_git status --porcelain -b 2> /dev/null)"
  177. # Don't continue on a catastrophic failure
  178. if [[ $? -eq 128 ]]; then
  179. return 1
  180. fi
  181. # A lookup table of each git status encountered
  182. local -A statuses_seen
  183. if __git_prompt_git rev-parse --verify refs/stash &>/dev/null; then
  184. statuses_seen[STASHED]=1
  185. fi
  186. local status_lines
  187. status_lines=("${(@f)${status_text}}")
  188. # If the tracking line exists, get and parse it
  189. if [[ "$status_lines[1]" =~ "^## [^ ]+ \[(.*)\]" ]]; then
  190. local branch_statuses
  191. branch_statuses=("${(@s/,/)match}")
  192. for branch_status in $branch_statuses; do
  193. if [[ ! $branch_status =~ "(behind|diverged|ahead) ([0-9]+)?" ]]; then
  194. continue
  195. fi
  196. local last_parsed_status=$prefix_constant_map[$match[1]]
  197. statuses_seen[$last_parsed_status]=$match[2]
  198. done
  199. fi
  200. # For each status prefix, do a regex comparison
  201. for status_prefix in ${(k)prefix_constant_map}; do
  202. local status_constant="${prefix_constant_map[$status_prefix]}"
  203. local status_regex="(^|\n)$status_prefix"
  204. if [[ "$status_text" =~ $status_regex ]]; then
  205. statuses_seen[$status_constant]=1
  206. fi
  207. done
  208. # Display the seen statuses in the order specified
  209. local status_prompt
  210. for status_constant in $status_constants; do
  211. if (( ${+statuses_seen[$status_constant]} )); then
  212. local next_display=$constant_prompt_map[$status_constant]
  213. status_prompt="$next_display$status_prompt"
  214. fi
  215. done
  216. echo $status_prompt
  217. }
  218. # Outputs the name of the current user
  219. # Usage example: $(git_current_user_name)
  220. function git_current_user_name() {
  221. __git_prompt_git config user.name 2>/dev/null
  222. }
  223. # Outputs the email of the current user
  224. # Usage example: $(git_current_user_email)
  225. function git_current_user_email() {
  226. __git_prompt_git config user.email 2>/dev/null
  227. }
  228. # Output the name of the root directory of the git repository
  229. # Usage example: $(git_repo_name)
  230. function git_repo_name() {
  231. local repo_path
  232. if repo_path="$(__git_prompt_git rev-parse --show-toplevel 2>/dev/null)" && [[ -n "$repo_path" ]]; then
  233. echo ${repo_path:t}
  234. fi
  235. }