Merge pull request #54 from olets/v4

v4 pt 1 (inc. release workflow write-up)

Author: olets

.gitignore

@@ -1,3 +1,4 @@
 dist
 node_modules
 *.zwc
+*.tar.gz

LICENSE

@@ -19,14 +19,13 @@ The Git Prompt Kit Spaceship section uses the default Git Prompt Kit's Git compo
 # Configure Spaceship
 SPACESHIP_PROMPT_ORDER=(
   # any other sections
-  git_prompt_kit
+  spaceship_git_prompt_kit
   # any other sections
 )
 
 # Configure Git Prompt Kit and any Git-Prompt-Kit config options
 # For example
 GIT_PROMPT_KIT_SHOW_INACTIVE_STATUS=0
-GIT_PROMPT_KIT_LINEBREAK_AFTER_GIT_REF=0
 
 # Use Git Prompt Kit and Spaceship
 # Load olets/git-prompt-kit/git-prompt-kit.spaceship.zsh
@@ -47,7 +46,6 @@ You can use Git Prompt Kit with [Starship](https://starship.rs/) (tested with zs
 # For example
 GIT_PROMPT_KIT_SHOW_INACTIVE_STATUS=0
 GIT_PROMPT_KIT_USE_DEFAULT_PROMPT=0
-GIT_PROMPT_KIT_LINEBREAK_AFTER_GIT_REF=0
 
 # Load Git Prompt Kit (will differ depending on installation method)
 
@@ -105,16 +103,16 @@ The construct `${x:+y}` is "print `$y` if `$x` is not null". In the context of p
 # Configure Git Prompt Kit
 GIT_PROMPT_KIT_COLOR_ACTION=yellow
 GIT_PROMPT_KIT_COLOR_ASSUME_UNCHANGED=yellow
+GIT_PROMPT_KIT_COLOR_CWD=blue
 GIT_PROMPT_KIT_COLOR_HEAD=green
 GIT_PROMPT_KIT_COLOR_REMOTE=red
 GIT_PROMPT_KIT_COLOR_SKIP_WORKTREE=yellow
 GIT_PROMPT_KIT_COLOR_STAGED=green
 GIT_PROMPT_KIT_COLOR_STASH=yellow
 GIT_PROMPT_KIT_COLOR_UNSTAGED=red
-GIT_PROMPT_KIT_COLOR_WORKDIR=blue
-GIT_PROMPT_KIT_CWD_TRAILING_COUNT=0
+GIT_PROMPT_KIT_CWD_MAX_TRAILING_COUNT=0
 GIT_PROMPT_KIT_GIT_STATUS_ON_OWN_LINE=0
-GIT_PROMPT_KIT_ROOT_TRAILING_COUNT=0
+GIT_PROMPT_KIT_REPO_SUBDIRECTORY_MAX_TRAILING_COUNT=0
 GIT_PROMPT_KIT_SHOW_INACTIVE_CONTEXT=0
 GIT_PROMPT_KIT_SHOW_INACTIVE_STATUS=0
 GIT_PROMPT_KIT_SYMBOL_CHAR_NORMAL=⮕
@@ -126,7 +124,7 @@ GIT_PROMPT_KIT_SYMBOL_STASH=≡
 PROMPT=
 PROMPT+=$'\n'
 PROMPT+='$GIT_PROMPT_KIT_CHAR '
-PROMPT+='${(s./.)GIT_PROMPT_KIT_WORKDIR}[-1] '
+PROMPT+='$GIT_PROMPT_KIT_COLOR_CWD '
 PROMPT+='${GIT_PROMPT_KIT_HEAD:+git:($GIT_PROMPT_KIT_HEAD}'
 PROMPT+='${GIT_PROMPT_KIT_ACTION:+ $GIT_PROMPT_KIT_ACTION}'
 PROMPT+='${GIT_PROMPT_KIT_BEHIND:+ $GIT_PROMPT_KIT_BEHIND}'
@@ -157,6 +155,7 @@ omg's oppa-lana-style. Requires a Font Awesome-patched font, see https://github.
 [[ $COLORTERM = *(24bit|truecolor)* ]] || zmodload zsh/nearcolor
 
 GIT_PROMPT_KIT_COLOR_ASSUME_UNCHANGED="#03343f"
+GIT_PROMPT_KIT_COLOR_CWD="white"
 GIT_PROMPT_KIT_COLOR_HEAD="#03343f"
 GIT_PROMPT_KIT_COLOR_INACTIVE="#eee8d9"
 GIT_PROMPT_KIT_COLOR_REMOTE="#03343f"
@@ -166,9 +165,8 @@ GIT_PROMPT_KIT_COLOR_STASH="#03343f"
 GIT_PROMPT_KIT_COLOR_SUCCEEDED="white"
 GIT_PROMPT_KIT_COLOR_TAG="#03343f"
 GIT_PROMPT_KIT_COLOR_UNSTAGED="#e0323b"
-GIT_PROMPT_KIT_COLOR_WORKDIR="white"
-GIT_PROMPT_KIT_CWD_TRAILING_COUNT=-1
-GIT_PROMPT_KIT_ROOT_TRAILING_COUNT=-1
+GIT_PROMPT_KIT_CWD_MAX_TRAILING_COUNT=-1
+GIT_PROMPT_KIT_REPO_SUBDIRECTORY_MAX_TRAILING_COUNT=-1
 GIT_PROMPT_KIT_SYMBOL_AHEAD="  "
 GIT_PROMPT_KIT_SYMBOL_BEHIND="  "
 GIT_PROMPT_KIT_SYMBOL_CHAR_NORMAL=•
@@ -208,7 +206,7 @@ PROMPT+='${GIT_PROMPT_KIT_HEAD:+) }'
 PROMPT+='${GIT_PROMPT_KIT_TAG:+$GIT_PROMPT_KIT_TAG }'
 PROMPT+='%k%F{#e0323b}${GIT_PROMPT_KIT_HEAD:+}%k'
 PROMPT+=$'\n'
-PROMPT+='$GIT_PROMPT_KIT_WORKDIR '
+PROMPT+='$GIT_PROMPT_KIT_CWD '
 PROMPT+='$GIT_PROMPT_KIT_CHAR '
 ```
 
@@ -225,6 +223,7 @@ PROMPT+='$GIT_PROMPT_KIT_CHAR '
 
 GIT_PROMPT_KIT_COLOR_ACTION=242
 GIT_PROMPT_KIT_COLOR_ASSUME_UNCHANGED=cyan
+GIT_PROMPT_KIT_COLOR_CWD=blue
 GIT_PROMPT_KIT_COLOR_FAILED=red
 GIT_PROMPT_KIT_COLOR_HEAD="#6c6c6c"
 GIT_PROMPT_KIT_COLOR_HOST=242
@@ -233,10 +232,9 @@ GIT_PROMPT_KIT_COLOR_SKIP_WORKTREE=cyan
 GIT_PROMPT_KIT_COLOR_STASH=cyan
 GIT_PROMPT_KIT_COLOR_SUCCEEDED=magenta
 GIT_PROMPT_KIT_COLOR_USER=242
-GIT_PROMPT_KIT_COLOR_WORKDIR=blue
-GIT_PROMPT_KIT_CWD_TRAILING_COUNT=-1
+GIT_PROMPT_KIT_CWD_MAX_TRAILING_COUNT=-1
 GIT_PROMPT_KIT_GIT_STATUS_ON_OWN_LINE=0
-GIT_PROMPT_KIT_ROOT_TRAILING_COUNT=-1
+GIT_PROMPT_KIT_REPO_SUBDIRECTORY_MAX_TRAILING_COUNT=-1
 GIT_PROMPT_KIT_SHOW_INACTIVE_STATUS=0
 GIT_PROMPT_KIT_SYMBOL_AHEAD=⇡
 GIT_PROMPT_KIT_SYMBOL_BEHIND=⇣
@@ -248,7 +246,7 @@ GIT_PROMPT_KIT_SYMBOL_STASH=≡
 # Build prompt
 PROMPT=
 PROMPT+=$'\n'
-PROMPT+='$GIT_PROMPT_KIT_WORKDIR'
+PROMPT+='$GIT_PROMPT_KIT_CWD'
 PROMPT+='${GIT_PROMPT_KIT_HEAD:+ $GIT_PROMPT_KIT_HEAD}'
 PROMPT+='${GIT_PROMPT_KIT_ACTION:+ $GIT_PROMPT_KIT_ACTION}'
 PROMPT+='${GIT_PROMPT_KIT_BEHIND:+ $GIT_PROMPT_KIT_BEHIND}'
@@ -268,14 +266,14 @@ Git symbol requires a Powerline-patched font, see https://github.com/powerline/f
 # ~/.zshrc
 # --- snip ---
 # Configure Git Prompt Kit
+GIT_PROMPT_KIT_COLOR_CWD=blue
 GIT_PROMPT_KIT_COLOR_HEAD=magenta
 GIT_PROMPT_KIT_COLOR_SKIP_WORKTREE=yellow
 GIT_PROMPT_KIT_COLOR_STAGED=green
 GIT_PROMPT_KIT_COLOR_STASH=yellow
 GIT_PROMPT_KIT_COLOR_UNSTAGED=red
-GIT_PROMPT_KIT_COLOR_WORKDIR=blue
-GIT_PROMPT_KIT_CWD_TRAILING_COUNT=2
-GIT_PROMPT_KIT_ROOT_TRAILING_COUNT=2
+GIT_PROMPT_KIT_CWD_MAX_TRAILING_COUNT=2
+GIT_PROMPT_KIT_REPO_SUBDIRECTORY_MAX_TRAILING_COUNT=2
 GIT_PROMPT_KIT_SYMBOL_AHEAD=⇡
 GIT_PROMPT_KIT_SYMBOL_BEHIND=⇣
 GIT_PROMPT_KIT_SYMBOL_BRANCH=" "
@@ -293,7 +291,7 @@ GIT_PROMPT_KIT_SYMBOL_UNTRACKED="?"
 # Build prompt
 PROMPT=
 PROMPT+=$'\n%B'
-PROMPT+='${(s./.)GIT_PROMPT_KIT_WORKDIR}[-3,-1] '
+PROMPT+='$GIT_PROMPT_KIT_CWD '
 PROMPT+='${GIT_PROMPT_KIT_HEAD:+on $GIT_PROMPT_KIT_HEAD }'
 PROMPT+='${GIT_PROMPT_KIT_REMOTE:+$GIT_PROMPT_KIT_REMOTE }'
 PROMPT+='%F{red}'

README.md

@@ -12,15 +12,10 @@ SPACESHIP_GIT_PROMPT_KIT_SUFFIX=${SPACESHIP_GIT_PROMPT_KIT_SUFFIX:- }
 spaceship_git_prompt_kit() {
   [[ $SPACESHIP_GIT_PROMPT_KIT_SHOW == false ]] && return
 
-  local 'git_prompt_kit_status'
-
-  git_prompt_kit_status=$(_git_prompt_kit_git_prompt)
-
-  [[ -z $git_prompt_kit_status ]] && return
+  [[ $VCS_STATUS_RESULT == 'ok-sync' ]] || return 0
 
   spaceship::section \
-    "" \
-    "$SPACESHIP_GIT_PROMPT_KIT_PREFIX" \
-    "$SPACESHIP_GIT_PROMPT_KIT_SYMBOL$(print -P $git_prompt_kit_status)" \
-    "$SPACESHIP_GIT_PROMPT_KIT_SUFFIX"
+    --prefix "$SPACESHIP_GIT_PROMPT_KIT_PREFIX" \
+    "$SPACESHIP_GIT_PROMPT_KIT_SYMBOL$(print -P ${GIT_PROMPT_KIT_REF:+$GIT_PROMPT_KIT_REF }${GIT_PROMPT_KIT_STATUS_EXTENDED:+$GIT_PROMPT_KIT_STATUS_EXTENDED }${GIT_PROMPT_KIT_STATUS:+$GIT_PROMPT_KIT_STATUS }${GIT_PROMPT_KIT_ACTION})" \
+    --suffix "$SPACESHIP_GIT_PROMPT_KIT_SUFFIX"
 }