git.zsh 11 KB

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