build: fix installer script PATH export (#178)

Author: Cyber-Syntax

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## v0.15.2-alpha
 ## v0.15.1-alpha
 ## v0.15.0-alpha
 ## v0.14.1-alpha

my-unicorn-installer.sh

@@ -1,32 +1,58 @@
 #!/usr/bin/env bash
 #
 # my-unicorn-installer.sh
-# User‑level installer & updater for "my-unicorn"
-# Handles venv creation, wrapper install, and shell rc setup
 # ------------------------------------------------
+# User-level installer & updater for "my-unicorn"
+# - Copies project files into XDG user data directory (~/.local/share)
+# - Creates/updates a Python virtual environment
+# - Installs a wrapper script in ~/.local/bin for easy command execution
+# - Ensures ~/.local/bin is in PATH for both bash and zsh shells
+#
+# Usage:
+#   ./my-unicorn-installer.sh install   # Install or reinstall
+#   ./my-unicorn-installer.sh update    # Update venv without touching files
+#
+# Exit immediately if:
+# - a command exits with a non-zero status (`-e`)
+# - an unset variable is used (`-u`)
+# - a pipeline fails anywhere (`-o pipefail`)
 set -euo pipefail
 
-# -- Configuration --
+# -- Configuration -----------------------------------------------------------
+
+# Where user-specific data should be stored
 XDG_DATA_HOME="${XDG_DATA_HOME:-$HOME/.local/share}"
+
+# Final install location of our project
 INSTALL_DIR="$XDG_DATA_HOME/my-unicorn"
+
+# Virtual environment directory inside install dir
 VENV_DIR="$INSTALL_DIR/venv"
+
+# Virtual environment bin folder (where python/pip are located)
 BIN_DIR="$VENV_DIR/bin"
+
+# Source of our wrapper script (inside repo)
 WRAPPER_SRC="$INSTALL_DIR/scripts/venv-wrapper.bash"
+
+# Destination of wrapper script in user's PATH
 WRAPPER_DST="$HOME/.local/bin/my-unicorn"
 
+# The line to add to shell rc files to ensure ~/.local/bin is in PATH
 EXPORT_LINE='export PATH="$HOME/.local/bin:$PATH"'
 
-# -- Helpers --
+# -- Helper functions --------------------------------------------------------
 
+# Get absolute directory path of currently running script (resolves symlinks)
 script_dir() {
-  # Resolve path to the currently running script
   local src="${BASH_SOURCE[0]}"
   while [ -h "$src" ]; do
     src="$(readlink "$src")"
   done
   dirname "$src"
 }
 
+# Detect which shell rc file to update for PATH (bash or zsh)
 detect_rc_file() {
   local rc user_shell
   user_shell="$(basename "${SHELL:-}")"
@@ -42,27 +68,61 @@ detect_rc_file() {
       rc="$HOME/.bashrc"
       ;;
   esac
+  # Create the file if it doesn't exist
   [[ ! -f "$rc" ]] && touch "$rc"
   echo "$rc"
 }
 
-ensure_path_in_rc() {
+# Ensure PATH line is present in a given file
+# $1 = rc file path
+# $2 = position (optional: prepend|append, default append)
+ensure_path_in_file() {
   local rc_file="$1"
+  local position="${2:-append}"
+  
+  [[ ! -f "$rc_file" ]] && touch "$rc_file"
+  
   if ! grep -Fxq "$EXPORT_LINE" "$rc_file"; then
-    printf "\n# Added by my-unicorn installer\n%s\n" "$EXPORT_LINE" >> "$rc_file"
-    echo "✅ Added '$HOME/.local/bin' to PATH in $rc_file"
+    if [[ "$position" == "prepend" ]]; then
+      # Put PATH export at the very top
+      {
+        echo "# Added by my-unicorn installer"
+        echo "$EXPORT_LINE"
+        echo
+        cat "$rc_file"
+      } > "$rc_file.tmp" && mv "$rc_file.tmp" "$rc_file"
+      echo "Added PATH to top of $rc_file"
+    else
+      # Add PATH export at the bottom
+      printf "\n# Added by my-unicorn installer\n$EXPORT_LINE\n" >> "$rc_file"
+      echo "Added PATH to bottom of $rc_file"
+    fi
   else
     echo "ℹ️ PATH already configured in $rc_file"
-  fi
+  fi  
 }
 
+# Ensure PATH is set for both bash and zsh shells
+# - Prepend for bashrc so it’s loaded before anything else
+# - Append for zshrc so it runs after bashrc in login shell chains
+ensure_path_for_shells() {
+  local bashrc="$HOME/.bashrc"
+  local zshrc="$HOME/.zshrc"
+  
+  [[ -f "$HOME/.config/zsh/.zshrc" ]] && zshrc="$HOME/.config/zsh/.zshrc"
+  
+  ensure_path_in_file "$bashrc" prepend
+  ensure_path_in_file "$zshrc" append
+}
+
+# Copy source files to install directory
 copy_source_to_install_dir() {
   echo "📁 Copying source files to $INSTALL_DIR..."
   local src_dir
   src_dir="$(script_dir)"
   mkdir -p "$INSTALL_DIR"
 
-  # List of directories/files to copy
+  # Source files to copy
   for item in my_unicorn scripts pyproject.toml "$(basename "$0")"; do
     local src_path="$src_dir/$item"
     local dst_path="$INSTALL_DIR/$item"
@@ -79,6 +139,7 @@ copy_source_to_install_dir() {
   done
 }
 
+# Create or update virtual environment and install package in editable mode
 setup_venv() {
   echo "🐍 Creating/updating virtual environment in $VENV_DIR..."
   python3 -m venv "$VENV_DIR"
@@ -88,35 +149,38 @@ setup_venv() {
   python3 -m pip install -e "$INSTALL_DIR"
 }
 
+# Install wrapper script into ~/.local/bin so `my-unicorn` works globally
 install_wrapper() {
   echo "🔧 Installing wrapper to $WRAPPER_DST..."
   mkdir -p "$(dirname "$WRAPPER_DST")"
   cp "$WRAPPER_SRC" "$WRAPPER_DST"
   chmod +x "$WRAPPER_DST"
 }
 
+# Full installation process
 install_my_unicorn() {
-  echo "=== Installing my‑unicorn ==="
+  echo "=== Installing my-unicorn ==="
   copy_source_to_install_dir
   setup_venv
   install_wrapper
-
+  ensure_path_for_shells
+  
   local rc
-  rc="$(detect_rc_file)"
-  ensure_path_in_rc "$rc"
+  rc=$(detect_rc_file)
 
   echo "✅ Installation complete."
   echo "Restart your shell or run 'source $rc' to apply PATH."
   echo "Run 'my-unicorn --help' to get started."
 }
 
+# Update only the virtual environment, keep existing files
 update_my_unicorn() {
-  echo "=== Updating my‑unicorn ==="
+  echo "=== Updating my-unicorn ==="
   setup_venv
   echo "✅ Update complete."
 }
 
-# -- Entry point --
+# -- Entry point -------------------------------------------------------------
 case "${1-}" in
   install|"") install_my_unicorn ;;
   update) update_my_unicorn ;;
@@ -130,4 +194,3 @@ EOF
     exit 1
     ;;
 esac
-

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = 'my-unicorn'
 # dynamic = ["version"]
-version = '0.15.1-alpha'
+version = '0.15.2-alpha'
 maintainers = [{ name = "Cyber-Syntax" }]
 license = { text = "GPL-3.0-or-later" }
 description = 'It downloads/updates appimages via GitHub API. It also validates the appimage with SHA256 and SHA512.'