spaceship-prompt 4.4.1 → 4.5.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [4.5.0](https://github.com/spaceship-prompt/spaceship-prompt/compare/v4.4.0...v4.5.0) (2022-09-23)
+
+
+### Bug Fixes
+
+* **crystal:** Include Crystal in order ([d215797](https://github.com/spaceship-prompt/spaceship-prompt/commit/d215797efc63e081cc6516aac6974a1ece6b255a))
+* fix grep unknown option: --color ([#1206](https://github.com/spaceship-prompt/spaceship-prompt/issues/1206)) ([8a16414](https://github.com/spaceship-prompt/spaceship-prompt/commit/8a16414d78a41e0e11574c55e323bef09835a77b)), closes [#1066](https://github.com/spaceship-prompt/spaceship-prompt/issues/1066)
+
+
+### Features
+
+* **crystal:** Add Crystal section for 4.x ([c72c6c9](https://github.com/spaceship-prompt/spaceship-prompt/commit/c72c6c94f74b0ab1e110c775cfb8ec655b90da0e))
+* **deno:** Add Deno section ([c43f8c5](https://github.com/spaceship-prompt/spaceship-prompt/commit/c43f8c5e4e3886f0ba612c1b347591bcc2b00880))
+
 ## [4.4.1](https://github.com/spaceship-prompt/spaceship-prompt/compare/v4.4.0...v4.4.1) (2022-09-21)
 
 

package/lib/core.zsh

@@ -3,9 +3,6 @@
 # Tools for loading sections, building sections and invoking the renderer
 # ------------------------------------------------------------------------------
 
-# Unique array of async jobs
-typeset -ahU SPACESHIP_JOBS=()
-
 # Loads the sections from files and functions
 # USAGE:
 #   spaceship::core::load_sections
@@ -32,17 +29,14 @@ spaceship::core::load_sections() {
   done
 
   if $load_async; then
-    (( ASYNC_INIT_DONE )) || {
-      builtin source "$SPACESHIP_ROOT/async.zsh"
-      spaceship::precompile "$SPACESHIP_ROOT/async.zsh"
-    }
+    spaceship::worker::load
   fi
 }
 
 # Iterate over sections, start async jobs and store results in cache
 # USAGE:
-#   spaceship::core::build_cache
-spaceship::core::build_cache() {
+#   spaceship::core::start
+spaceship::core::start() {
   # Clear the cache before every render
   spaceship::cache::clear
 
@@ -56,19 +50,44 @@ spaceship::core::build_cache() {
 #   spaceship::core::async_callback
 spaceship::core::async_callback() {
   local job="$1" ret="$2" output="$3" exec_time="$4" err="$5" has_next="$6"
-  local section
-
-  # ignore the async evals used to alter worker environment
-  if [[ "${job}" == "[async/eval]" ]] \
-  || [[ "${job}" == ";" ]] \
-  || [[ "${job}" == "[async]" ]]; then
-    # FIXME: Restart the async job if it failed
-    return
-  fi
-
-  section="${job#"spaceship_"}" # TODO: Move spaceship_ to a constant
-
-  SPACESHIP_JOBS=("${(@)SPACESHIP_JOBS:#${section}}")
+  local section="${job#"spaceship_"}" # TODO: Move spaceship_ to a constant
+
+  # Notify the worker that the job is done
+  spaceship::worker::callback "$@"
+
+  case $job in
+    "[async]")
+      # Handle all the errors that could indicate a crashed async worker.
+      # See zsh-async documentation for the definition of the exit codes.
+      if (( code == 2 )) || (( code == 3 )) || (( code == 130 )); then
+        # Our worker died unexpectedly, try to recover immediately.
+        spaceship::worker::init
+        spaceship::core::start
+        return
+      fi
+      ;;
+    "[async/eval]")
+      if (( code )); then
+        # Looks like eval failed, rerun async tasks just in case.
+        spaceship::core::start
+        return
+      fi
+      ;;
+    ";")
+      # Ignore the async evals used to alter worker environment
+      return
+      ;;
+    *)
+      # Hanlde regular successfully finished jobs
+      # Skip prompt re-rendering if section is empty
+      if [[ "$(spaceship::cache::get $section)" == "$output" ]]; then
+        return
+      fi
+
+      # Update section cache
+      spaceship::cache::set "$section" "$output"
+      ;;
+  esac
 
   # Refresh async section when the last async job has finished
   if [[ "${#SPACESHIP_JOBS}" -eq 0 ]]; then
@@ -76,13 +95,6 @@ spaceship::core::async_callback() {
     spaceship::core::render
   fi
 
-  # Skip prompt re-rendering if section is empty
-  if [[ "$(spaceship::cache::get $section)" == "$output" ]]; then
-    return
-  fi
-
-  spaceship::cache::set "$section" "$output"
-
   if [[ "$has_next" == 0 ]]; then
     spaceship::core::render
   fi
@@ -112,8 +124,7 @@ spaceship::core::refresh_section() {
   fi
 
   if spaceship::is_section_async "$section" && [[ -z $sync ]]; then
-    SPACESHIP_JOBS+=("$section")
-    async_job "spaceship" "spaceship_${section}"
+    spaceship::worker::run "spaceship_$section"
   else
     spaceship::cache::set "$section" "$(spaceship_$section)"
   fi
@@ -150,5 +161,5 @@ spaceship::core::render() {
   # .reset-prompt: bypass the zsh-syntax-highlighting wrapper
   # https://github.com/sorin-ionescu/prezto/issues/1026
   # https://github.com/zsh-users/zsh-autosuggestions/issues/107#issuecomment-183824034
-  zle .reset-prompt && zle -R
+  zle && zle .reset-prompt && zle -R
 }

package/lib/hooks.zsh

@@ -39,18 +39,10 @@ prompt_spaceship_precmd() {
   spaceship_exec_time_stop
 
   # Restarts the async worker, in order to get an update-to-date shell environment
-  if spaceship::is_prompt_async; then
-    SPACESHIP_JOBS=()
-    # restart worker
-    async_stop_worker "spaceship"
-    async_start_worker "spaceship" -n -u
-    # setopt before call register to avoid callback by async_worker_eval
-    async_worker_eval "spaceship" 'setopt extendedglob'
-    async_register_callback "spaceship" "spaceship::core::async_callback"
-  fi
+  spaceship::worker::init
 
   # Start building cache from sections
-  spaceship::core::build_cache
+  spaceship::core::start
 
   # Initiate the first render
   spaceship::populate
@@ -59,9 +51,7 @@ prompt_spaceship_precmd() {
 # A hook right before the command is started executing
 prompt_spaceship_preexec() {
   # Stop running prompt async jobs
-  if spaceship::is_prompt_async; then
-    async_flush_jobs "spaceship"
-  fi
+  spaceship::worker::flush
 
   # Start measuring exec_time right before executing the command
   spaceship_exec_time_start
@@ -69,9 +59,7 @@ prompt_spaceship_preexec() {
 
 # A hook after changing the working directory
 prompt_spaceship_chpwd() {
-  if spaceship::is_prompt_async; then
-    async_worker_eval "spaceship" 'cd' "$PWD"
-  fi
+  spaceship::worker::eval builtin cd -q $PWD
 
   # Restart execution time recording once dir is changed
   spaceship_exec_time_start

package/lib/worker.zsh

@@ -0,0 +1,67 @@
+# ------------------------------------------------------------------------------
+# WORKER
+# Spaceship wrapper around zsh-async
+# ------------------------------------------------------------------------------
+
+# Unique array of async jobs
+typeset -ahU SPACESHIP_JOBS=()
+
+# Load zsh-async if not loaded yet
+spaceship::worker::load() {
+  if ! (( ASYNC_INIT_DONE )); then
+    builtin source "$SPACESHIP_ROOT/async.zsh"
+    spaceship::precompile "$SPACESHIP_ROOT/async.zsh"
+  fi
+}
+
+# Lower worker priority to avoid slowing down the prompt
+spaceship::worker::renice() {
+  if command -v renice >/dev/null; then
+    command renice +15 -p $$
+  fi
+
+  if command -v ionice >/dev/null; then
+    command ionice -c 3 -p $$
+  fi
+}
+
+# This should be called to in callback to update the job counter
+spaceship::worker::callback() {
+  SPACESHIP_JOBS=("${(@)SPACESHIP_JOBS:#${1}}")
+}
+
+# Start the worker and prepare the environment
+spaceship::worker::init() {
+  if spaceship::is_prompt_async; then
+    SPACESHIP_JOBS=()
+    # restart worker
+    async_stop_worker "spaceship"
+    async_start_worker "spaceship" -n -u
+    # setopt before call register to avoid callback by async_worker_eval
+    async_worker_eval "spaceship" setopt extendedglob
+    async_worker_eval "spaceship" spaceship::worker::renice
+    async_register_callback "spaceship" spaceship::core::async_callback
+  fi
+}
+
+# Flush jobs for stopped worker
+spaceship::worker::flush() {
+  if spaceship::is_prompt_async; then
+    async_flush_jobs "spaceship"
+  fi
+}
+
+# Eval command inside the worker
+spaceship::worker::eval() {
+  if spaceship::is_prompt_async; then
+    async_worker_eval "spaceship" "$@"
+  fi
+}
+
+# Run a job in a worker
+spaceship::worker::run() {
+  if spaceship::is_prompt_async; then
+    SPACESHIP_JOBS+=("$1")
+    async_job "spaceship" "$@"
+  fi
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spaceship-prompt",
-  "version": "4.4.1",
+  "version": "4.5.0",
   "description": "A Zsh prompt for Astronauts.",
   "files": [
     "lib",

package/sections/crystal.zsh

@@ -0,0 +1,41 @@
+#
+# Crystal
+#
+# Crystal is a programming that aimes to be "fast as C, slick as Ruby."
+# Link: https://www.crystal-lang.org
+
+# ------------------------------------------------------------------------------
+# Configuration
+# ------------------------------------------------------------------------------
+
+SPACESHIP_CRYSTAL_SHOW="${SPACESHIP_CRYSTAL_SHOW=true}"
+SPACESHIP_CRYSTAL_ASYNC="${SPACESHIP_CRYSTAL_ASYNC=true}"
+SPACESHIP_CRYSTAL_PREFIX="${SPACESHIP_CRYSTAL_PREFIX="$SPACESHIP_PROMPT_DEFAULT_PREFIX"}"
+SPACESHIP_CRYSTAL_SUFFIX="${SPACESHIP_CRYSTAL_SUFFIX="$SPACESHIP_PROMPT_DEFAULT_SUFFIX"}"
+SPACESHIP_CRYSTAL_SYMBOL="${SPACESHIP_CRYSTAL_SYMBOL="🔮 "}"
+SPACESHIP_CRYSTAL_COLOR="${SPACESHIP_CRYSTAL_COLOR=069}"
+
+# ------------------------------------------------------------------------------
+# Section
+# ------------------------------------------------------------------------------
+
+# Show current version of Crystal
+spaceship_crystal() {
+  [[ $SPACESHIP_CRYSTAL_SHOW == false ]] && return
+
+  # Return when crystal is not installed
+  spaceship::exists crystal || return
+
+  # If we are in a Crystal-specific project
+  local is_crystal_project="$(spaceship::upsearch shard.yml)"
+  [[ -n "$is_crystal_project" || -n *.cr(#qN^/) ]] || return
+
+  local crystal_version=$(crystal --version | awk '/Crystal*/ {print $2}')
+
+  spaceship::section \
+    --color "$SPACESHIP_CRYSTAL_COLOR" \
+    --prefix "$SPACESHIP_CRYSTAL_PREFIX" \
+    --suffix "$SPACESHIP_CRYSTAL_SUFFIX" \
+    --symbol "$SPACESHIP_CRYSTAL_SYMBOL" \
+    "v$crystal_version"
+}

package/sections/deno.zsh

@@ -0,0 +1,44 @@
+#
+# Deno
+#
+# Deno is secure runtime for JavaScript and TypeScript.
+# Link: https://deno.land/
+
+# ------------------------------------------------------------------------------
+# Configuration
+# ------------------------------------------------------------------------------
+
+SPACESHIP_DENO_SHOW="${SPACESHIP_DENO_SHOW=true}"
+SPACESHIP_DENO_ASYNC="${SPACESHIP_DENO_ASYNC=true}"
+SPACESHIP_DENO_PREFIX="${SPACESHIP_DENO_PREFIX="$SPACESHIP_PROMPT_DEFAULT_PREFIX"}"
+SPACESHIP_DENO_SUFFIX="${SPACESHIP_DENO_SUFFIX="$SPACESHIP_PROMPT_DEFAULT_SUFFIX"}"
+SPACESHIP_DENO_SYMBOL="${SPACESHIP_DENO_SYMBOL="🦕 "}"
+SPACESHIP_DENO_DEFAULT_VERSION="${SPACESHIP_DENO_DEFAULT_VERSION=""}"
+SPACESHIP_DENO_COLOR="${SPACESHIP_DENO_COLOR="cyan"}"
+
+# ------------------------------------------------------------------------------
+# Section
+# ------------------------------------------------------------------------------
+
+# Show current version of Deno
+spaceship_deno() {
+  [[ $SPACESHIP_DENO_SHOW == false ]] && return
+
+  # Return when deno is not installed
+  spaceship::exists deno || return
+
+  # Show Deno status only for Deno-specific folders
+  local is_deno_project="$(spaceship::upsearch deno.json deno.jsonc)"
+  [[ -n "$is_deno_project" || -n {mod,dep,main,cli}.ts(#qN^/) ]] || return
+
+  local deno_version=$(deno --version 2>/dev/null | head -1 | cut -d' ' -f2)
+
+  [[ "$deno_version" == "$SPACESHIP_DENO_DEFAULT_VERSION" ]] && return
+
+  spaceship::section \
+    --color "$SPACESHIP_DENO_COLOR" \
+    --prefix "$SPACESHIP_DENO_PREFIX" \
+    --suffix "$SPACESHIP_DENO_SUFFIX" \
+    --symbol "$SPACESHIP_DENO_SYMBOL" \
+    "v$deno_version"
+}

package/spaceship.zsh

@@ -7,7 +7,7 @@
 
 # Current version of Spaceship
 # Useful for issue reporting
-export SPACESHIP_VERSION='4.4.1'
+export SPACESHIP_VERSION='4.5.0'
 
 # Determination of Spaceship working directory
 # https://git.io/vdBH7
@@ -36,7 +36,7 @@ fi
 
 if [ -z "$SPACESHIP_PROMPT_ORDER" ]; then
   SPACESHIP_PROMPT_ORDER=(
-    time          # Time stampts section
+    time          # Time stamps section
     user          # Username section
     dir           # Current directory section
     host          # Hostname section
@@ -45,6 +45,7 @@ if [ -z "$SPACESHIP_PROMPT_ORDER" ]; then
     package       # Package version
     node          # Node.js section
     bun           # Bun section
+    deno          # Deno section
     ruby          # Ruby section
     python        # Python section
     elm           # Elm section
@@ -57,6 +58,7 @@ if [ -z "$SPACESHIP_PROMPT_ORDER" ]; then
     haskell       # Haskell Stack section
     java          # Java section
     julia         # Julia section
+    crystal       # Crystal section
     docker        # Docker section
     aws           # Amazon Web Services section
     gcloud        # Google Cloud Platform section
@@ -100,6 +102,7 @@ SPACESHIP_PROMPT_DEFAULT_SUFFIX="${SPACESHIP_PROMPT_DEFAULT_SUFFIX=" "}"
 SPACESHIP_LIBS=(
   "lib/utils.zsh"   # General porpuse utils
   "lib/cache.zsh"   # Cache utils
+  "lib/worker.zsh"  # Async worker
   "lib/hooks.zsh"   # Zsh hooks
   "lib/section.zsh" # Section utils
   "lib/core.zsh"    # Core functions for loading and rendering