git.zsh 10 KB

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