ReadMe.md

lenvup.sh

Laravel Environment Dependency Management Script

by: @aldoyh

Description:

lenvup.sh is a Bash script designed to streamline the setup and maintenance of Laravel project dependencies. It intelligently handles both Composer (PHP) and various Node.js package managers (npm, Yarn, pnpm, and Bun), ensuring your project's dependencies are correctly installed and updated. The script checks for the presence of composer.json and package.json, then examines their respective lock files to determine the appropriate action.

Key Features:

• Composer Management:
  • If composer.lock exists, runs composer update -o and composer upgrade to update dependencies with optimizations.
  • If composer.lock is missing, runs composer install followed by composer update -i for interactive updates.
• Node.js Package Management:
  • Intelligently detects the presence of package-lock.json, yarn.lock, pnpm-lock.yaml, or bun.lockb.
  • Runs the appropriate update command (npm update, yarn update, pnpm update, or bun update) based on the detected lock file.
  • If no lock file is found for any of the package managers, and a package.json exists, it will then install using npm, yarn, pnpm, or bun, respectively, and then run the dev script.
• Error Handling:
  • gracefully skips if no package.json
  • checks if there's any other lock files before installing dependencies using npm, yarn, pnpm, or bun
  • includes basic error checking and reporting for each command execution.
• Detailed Reporting:
  • Provides a comprehensive report of all actions taken, including timestamps and success/failure indicators.
  • Offers the option to save the report as a Markdown file for record-keeping.
• Laravel Focused:
  • specifically crafted to follow best practices for Laravel development workflows.

Usage:

The script is designed to be run in the root directory of your Laravel project. It automatically detects the necessary files and executes the appropriate commands.

One-liner to Clone, CHMOD, and Run:

git clone https://gist.github.com/aldoyh/a05a94d85cde84abe60f459c2caf7b44.git ~/.lenvup && cd ~/.lenvup && chmod +x lenvup.sh && ./lenvup.sh && cd .. && rm -rf ~/.lenvup

Further Development:

This script is a robust starting point for managing Laravel dependencies. Future enhancements could include:

• More granular control over update behavior.
• Support for additional package managers or build tools.
• Integration with CI/CD pipelines.

Contribution:

Contributions and suggestions are welcome! Feel free to fork the gist and submit pull requests.

lenvup.sh

#!/bin/bash

# --- Configuration ---
c="composer"
i="install"
u="update"
uu="upgrade"
n="npm"
p="pnpm"
b="bun"
y="yarn"

report=""
timestamp=$(date +"%Y-%m-%d %H:%M:%S")

# --- Helper Functions ---

add_to_report() {
  report+="$1\n"
}

print_step() {
  echo -e "\033[1m➡️  $1\033[0m"
  add_to_report "## $timestamp - $1"
}

print_report() {
  echo -e "\n\033[1;32m--- Operation Report ---\033[0m"
  echo -e "$report"
  echo -e "\033[1;32m--- End of Report ---\033[0m\n"
}

check_for_other_lock_files() {
    if [ -f "package-lock.json" ] || [ -f "yarn.lock" ] || [ -f "pnpm-lock.yaml" ] || [ -f "bun.lockb" ]; then
        return 0  # Other lock file found
    else
        return 1  # No other lock file found
    fi
}

# --- Composer Logic ---

if [ -f "composer.json" ]; then
  print_step "composer.json found, processing..."

  if [ -f "composer.lock" ]; then
    print_step "composer.lock found, updating dependencies with optimization..."
    if ! $c $u -o; then
        add_to_report "  - ❌ Failed to run: composer update -o"
    else
        add_to_report "  - ✅ Ran: composer update -o"
    fi
    if ! $c $uu; then
        add_to_report "  - ❌ Failed to run: composer upgrade"
    else
        add_to_report "  - ✅ Ran: composer upgrade"
    fi
  else
    print_step "composer.lock not found, installing and updating dependencies interactively..."
    if ! $c $i; then
        add_to_report "  - ❌ Failed to run: composer install"
    else
        add_to_report "  - ✅ Ran: composer install"
    fi
    if ! $c $u -i; then
        add_to_report "  - ❌ Failed to run: composer update -i"
    else
        add_to_report "  - ✅ Ran: composer update -i"
    fi
  fi
else
  print_step "composer.json not found, skipping Composer."
fi

# --- NPM Logic ---

if [ -f "package.json" ]; then
  print_step "package.json found, processing with npm..."

  if [ -f "package-lock.json" ]; then
    print_step "package-lock.json found, updating dependencies..."
    if ! $n $u; then
        add_to_report "  - ❌ Failed to run: npm update"
    else
        add_to_report "  - ✅ Ran: npm update"
    fi
  else
    if check_for_other_lock_files; then
        print_step "No lock file found, skipping npm install."
    else
        print_step "package-lock.json not found, installing dependencies and running dev script..."
        if ! $n $i; then
            add_to_report "  - ❌ Failed to run: npm install"
        else
            add_to_report "  - ✅ Ran: npm install"
        fi
        if ! $n run dev; then
            add_to_report "  - ❌ Failed to run: npm run dev"
        else
            add_to_report "  - ✅ Ran: npm run dev"
        fi
    fi
  fi
fi

# --- Yarn Logic ---

if [ -f "package.json" ]; then
    print_step "package.json found, checking for yarn.lock..."
    if [ -f "yarn.lock" ]; then
        print_step "yarn.lock found, processing with yarn..."
        if ! $y $u; then
            add_to_report "  - ❌ Failed to run: yarn update"
        else
            add_to_report "  - ✅ Ran: yarn update"
        fi
    else
        if check_for_other_lock_files; then
            print_step "No lock file found, skipping yarn install."
        else
            print_step "yarn.lock not found, installing with yarn since no other lock files are present..."
            if ! $y; then
                add_to_report "  - ❌ Failed to run: yarn install"
            else
                add_to_report "  - ✅ Ran: yarn install"
            fi
            if ! $y run dev; then
                add_to_report "  - ❌ Failed to run: yarn run dev"
            else
                add_to_report "  - ✅ Ran: yarn run dev"
            fi
        fi
    fi
fi

# --- PNPM Logic ---

if [ -f "package.json" ]; then
  print_step "package.json found, checking for pnpm-lock.yaml..."

  if [ -f "pnpm-lock.yaml" ]; then
    print_step "pnpm-lock.yaml found, processing with pnpm..."
    if ! $p $u; then
        add_to_report "  - ❌ Failed to run: pnpm update"
    else
        add_to_report "  - ✅ Ran: pnpm update"
    fi
  else
      if check_for_other_lock_files; then
          print_step "No lock file found, skipping pnpm install."
      else
          print_step "pnpm-lock.yaml not found, installing with pnpm since no other lock files are present..."
          if ! $p $i; then
              add_to_report "  - ❌ Failed to run: pnpm install"
          else
              add_to_report "  - ✅ Ran: pnpm install"
          fi
          if ! $p run dev; then
              add_to_report "  - ❌ Failed to run: pnpm run dev"
          else
              add_to_report "  - ✅ Ran: pnpm run dev"
          fi
      fi
  fi
fi

# --- Bun Logic ---

if [ -f "package.json" ]; then
  print_step "package.json found, checking for bun.lockb..."

  if [ -f "bun.lockb" ]; then
    print_step "bun.lockb found, processing with Bun..."
    if ! $b $u; then
        add_to_report "  - ❌ Failed to run: bun update"
    else
        add_to_report "  - ✅ Ran: bun update"
    fi
  else
      if check_for_other_lock_files; then
          print_step "No lock file found, skipping bun install."
      else
        print_step "bun.lockb not found, installing with Bun since no other lock files are present..."
        if ! $b $i; then
            add_to_report "  - ❌ Failed to run: bun install"
        else
            add_to_report "  - ✅ Ran: bun install"
        fi
        if ! $b run dev; then
            add_to_report "  - ❌ Failed to run: bun run dev"
        else
            add_to_report "  - ✅ Ran: bun run dev"
        fi
      fi
  fi
fi

# --- Final Report ---

print_report

read -r -p "Save the report as a markdown file? (y/n): " response
if [[ "$response" =~ ^([yY][eE][sS]|[yY])$ ]]; then
  filename="laravel_dev_report_$timestamp.md"
  echo "$report" > "$filename"
  echo -e "\033[1;32mReport saved as $filename\033[0m"
fi