perf(maintenance): ⚡️ Improve code logic. (#6)

* perf(maintenance): ⚡️ Improve code logic.

* Update zsh-zoxide.plugin.zsh

Fix: SH_GLOB

Co-authored-by: pskarma <49123165+pskarma@users.noreply.github.com>
Signed-off-by: Salvydas Lukosius <sall@w-ss.io>

* refactor: ⚡️ Updated exit codes

* Update functions/.zi-prepare-zoxide

Corrects indentation.

Signed-off-by: Salvydas Lukosius <sall@w-ss.io>

* Update zsh-zoxide.plugin.zsh

Signed-off-by: Salvydas Lukosius <sall@w-ss.io>

Signed-off-by: Salvydas Lukosius <sall@w-ss.io>
Co-authored-by: pskarma <49123165+pskarma@users.noreply.github.com>

Author: ss-o

.trunk/.gitignore

@@ -1,3 +1,4 @@
 *out
 *logs
+*plugins
 external

.trunk/trunk.yaml

@@ -1,10 +1,10 @@
 version: 0.1
 cli:
-  version: 0.15.1-beta
+  version: 0.16.1-beta
 lint:
   enabled:
     - actionlint@1.6.15
     - git-diff-check@SYSTEM
-    - gitleaks@8.9.0
+    - gitleaks@8.10.3
     - markdownlint@0.32.1
     - prettier@2.7.1

docs/README.md

@@ -26,7 +26,7 @@ zi light ajeetdsouza/zoxide
 
 ### Install zsh-zoxide
 
-#### Standart syntax
+#### Standard syntax
 
 ```zsh
 zi ice has'zoxide'
@@ -67,7 +67,7 @@ x foo /            # cd into a subdirectory starting with foo
 x ~/foo            # x also works like a regular cd command
 x foo/             # cd into relative path
 x ..               # cd one level up
-x -                # cd into previous directory
+x -                # cd into the previous directory
 ```
 
 ```sh
@@ -80,4 +80,4 @@ x foo<SPACE><TAB>  # show interactive completions
 
 ### Environment variables and usage with other plugin managers
 
-The plugin will call `zoxide init` with prefixed commands `z`, `zi`.
+The plugin will call `zoxide init` with prefixed commands `z`, and `zi`.

functions/.zi-prepare-zoxide

@@ -1,27 +1,37 @@
 #autoload
 # -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*-
 # vim: ft=zsh sw=2 ts=2 et
-
+#
+# Return 101 if directory failed to be created.
+# Return 201 failed to copy files.
+#
+# Zsh Plugin Standard
+# https://wiki.zshell.dev/community/zsh_plugin_standard#standard-recommended-options
 builtin emulate -L zsh ${=${options[xtrace]:#off}:+-o xtrace}
 builtin setopt extended_glob warn_create_global \
 typeset_silent no_short_loops rc_quotes no_auto_pushd
 
-# - The directory in which the database is stored.
-# - Manpages copied to set / default localtion.
-if (( ${ZI[SOURCED]} )) && [[ -d ${ZPFX} ]]; then
-  if [[ ! -d ${ZPFX}/share ]]; then
-    command mkdir -p ${ZPFX}/share || \
-    +zi-message "{error}Failed to create directory for database.{rst}"
-  fi
-  typeset -g _ZO_DATA_DIR=${ZPFX}/share
-  if [[ -d ${ZI[MAN_DIR]} ]] && [[ -d ${Plugins[ZSH_ZOXIDE]}/man/man1 ]]; then
-    cp ${Plugins[ZSH_ZOXIDE]}/man/man1/* ${ZI[MAN_DIR]}/man1/ || \
+integer ret=0
+
+# The directory in which the database is stored.
+if [[ ! -d ${ZPFX}/share ]]; then
+  # Create directory if it doesn't exist, else show error.
+  command mkdir -p "${ZPFX}"/share || {
+    print "Failed to create directory ${ZPFX}/share"
+    ret=101
+  }
+fi
+
+# Manpages are copied to set / default location.
+if [[ -d ${ZI[MAN_DIR]} ]] && [[ -d ${Plugins[ZSH_ZOXIDE]:?}/man/man1 ]]; then
+  # Copy manpages if existing, else show error
+  command cp "${Plugins[ZSH_ZOXIDE]}"/man/man1/* "${ZI[MAN_DIR]}"/man1/ || {
     +zi-message "{error}Failed to install manpages.{rst}"
-  fi
+    ret=201
+  }
 fi
 
 # Set zoxide commands x, xi when using with Zi.
-if (( ${ZI[SOURCED]} )) && \
-(( ${+functions[zi]} )) && [[ -z ${_ZO_CMD_PREFIX} ]]; then
-  typeset -g _ZO_CMD_PREFIX=x
-fi
+[[ -z $_ZO_CMD_PREFIX ]] && typeset -g _ZO_CMD_PREFIX=x
+
+return $ret

functions/.zsh-prepare-zoxide

@@ -0,0 +1,50 @@
+#autoload
+# -*- mode: zsh; sh-indentation: 2; indent-tabs-mode: nil; sh-basic-offset: 2; -*-
+# vim: ft=zsh sw=2 ts=2 et
+#
+# Return 100 if missing dependencies.
+# Return 110 for incorrect dependencies version.
+# Return 102 if git submodule failed to be initialized.
+#
+# Zsh Plugin Standard
+# https://wiki.zshell.dev/community/zsh_plugin_standard#standard-recommended-options
+builtin emulate -L zsh ${=${options[xtrace]:#off}:+-o xtrace}
+builtin setopt extended_glob warn_create_global typeset_silent \
+no_short_loops rc_quotes no_auto_pushd
+
+integer ret=0
+
+# Check dependencies
+typeset -a dependencies
+typeset dependency
+
+dependencies=( "git" "zoxide" )
+for dependency in "${dependencies[@]}"; do
+  (( ${+commands[$dependency]} )) || {
+    print "Missing dependency: $dependency"
+    ret=100
+  }
+done
+
+# Check if fzf has minimal required version.
+if (( ${+commands[fzf]} )); then
+  typeset fzf_version
+  fzf_version=$(fzf --version | awk -F '.' '{print $2}')
+  if [[ $fzf_version -lt 21 ]]; then
+    print "The fzf version is too old. Please update to version 0.21.0 or higher."
+    print "Note: zoxide only supports fzf v0.21.0 and above."
+    ret=110
+  fi
+fi
+
+# Initialize git submodule if required.
+if [[ ! -f ${Plugins[ZSH_ZOXIDE]:?}/man/man1/zoxide-add.1 ]]; then
+  command git submodule --quiet init
+  command git submodule --quiet update
+  if [[ ! -f ${Plugins[ZSH_ZOXIDE]}/man/man1/zoxide.1 ]]; then
+    print "Failed to initiate git submodules"
+    ret=102
+  fi
+fi
+
+return $ret

zsh-zoxide.plugin.zsh

@@ -3,8 +3,8 @@
 #
 # Zsh Plugin Standard
 # https://wiki.zshell.dev/community/zsh_plugin_standard#zero-handling
-0="${ZERO:-${${0:#$ZSH_ARGZERO}:-${(%):-%N}}}"
-0="${${(M)0:#/*}:-$PWD/$0}"
+  0="${ZERO:-${${0:#$ZSH_ARGZERO}:-${(%):-%N}}}"
+  0="${${(M)0:#/*}:-$PWD/$0}"
 
 # https://wiki.zshell.dev/community/zsh_plugin_standard#standard-plugins-hash
 typeset -gA Plugins
@@ -15,23 +15,47 @@ if [[ $PMSPEC != *f* ]]; then
   fpath+=( "${0:h}/functions" )
 fi
 
+# https://wiki.zshell.dev/community/zsh_plugin_standard#global-parameter-with-capabilities
+if [[ $PMSPEC == *P* ]]; then
+  _ZO_DATA_DIR=${ZPFX}/share
+fi
+
 # Autoload functions
-autoload -Uz "${0:h}/functions"/.*(.:t)
-
-if [[ ! -f ${Plugins[ZSH_ZOXIDE]}/man/man1/zoxide.1 ]]; then
-  command git submodule --quiet init
-  command git submodule --quiet update
-  if [[ ! -f ${Plugins[ZSH_ZOXIDE]}/man/man1/zoxide-add.1 ]]; then
-    print "Failed to initiate git submodules"
-    return 1
+autoload -Uz .{zi,zsh}-prepare-zoxide
+
+# TODO: Investigate variables and functions.
+# Unset variables and functions which is not required after initialization.
+
+# Check and prepare zsh-zoxide.
+# Used only once when zsh-zoxide is installed, or then
+# Plugins[ZSH_ZOXIDE_READY] reset to 0 to prevent full re-initialization
+if (( ! Plugins[ZSH_ZOXIDE_READY] )); then
+  # Set zoxide as ready to initiate.
+  Plugins[ZSH_ZOXIDE_READY]=1
+  # Returns 100 if missing dependencies.
+  # Returns 110 for incorrect dependencies version.
+  # Returns 102 if git submodule failed to be initialized.
+  .zsh-prepare-zoxide
+  exit_code=$?
+  if (( exit_code )); then
+    print "Failed to prepare zoxide, exit code: $exit_code"
+    return $exit_code
+  fi
+  # Prepare for Zi.
+  if (( ZI[SOURCED] )) && [[ -d $ZPFX ]]; then
+    # Returns 101 if directory failed to be created.
+    # Returns 201 failed to copy files.
+    .zi-prepare-zoxide
+    exit_code=$?
+    if (( exit_code )); then
+      print "Failed to prepare Zi, exit code: $exit_code"
+      return $exit_code
+    fi
   fi
 fi
 
-# When using Zi:
-.zi-prepare-zoxide
-
-# TODO: Env variables
-# If not set for Zi use default or user prefered.
+# TODO: Investigate variables for potential use.
+# Set variable to preferred prefix.
 : ${_ZO_CMD_PREFIX:=$_ZO_CMD_PREFIX}
 # Directory in which the database is stored.
 : ${_ZO_DATA_DIR:=$_ZO_DATA_DIR}
@@ -46,14 +70,27 @@ fi
 # When set to 1, x will resolve symlinks before adding directories to the database.
 # _ZO_RESOLVE_SYMLINKS
 
-# Expand any tilde in the path.
-export _ZO_DATA_DIR=${~_ZO_DATA_DIR}
-
-# TODO: Output failures
-if (( $+commands[zoxide] )); then
+if (( ${+commands[zoxide]} )); then
+  if [[ -n $_ZO_DATA_DIR ]]; then
+    # If a parameter specified does not already exist, it is created in the global scope,
+    # The variable is set to the absolute path of the directory.
+    typeset -gx _ZO_DATA_DIR=${~_ZO_DATA_DIR}
+  fi
+  # TODO: Check zoxide exit codes for possible improvements.
   if [[ $_ZO_CMD_PREFIX =~ ^[a-zA-Z]*$ ]]; then
+    # Set zoxide commands x, xi when using with Zi.
     eval "$(zoxide init zsh --cmd $_ZO_CMD_PREFIX)"
-  else
+    exit_code=$?
+  elif (( ! _ZO_CMD_PREFIX )); then
     eval "$(zoxide init zsh)"
+    exit_code=$?
+  fi
+  if (( exit_code )); then
+    print "Failed to initialize zoxide, exit code: $exit_code"
+    return $exit_code
   fi
+else
+  print "Please install zoxide or make sure it is in your PATH"
+  print "More info: https://github.com/ajeetdsouza/zoxide#installation"
+  exit 1
 fi