Add scrips formatting

Author: arthurfiorette

.dockerignore

@@ -4,3 +4,4 @@
 LICENSE
 .gitignore
 test.sh
+format.sh

.githooks/pre-commit

@@ -0,0 +1,2 @@
+#!/bin/sh
+./format.sh -s

.github/workflows/build.yml

@@ -36,11 +36,8 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Lint shell scripts
-        run: |
-          sudo apt-get update && sudo apt-get install -y shellcheck
-          shellcheck devwork-versions .profile || true
-          echo "Shell script linting completed"
+      - name: Check shell script formatting
+        run: ./format.sh -c
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

README.md

@@ -234,6 +234,12 @@ docker run --rm devwork:24-node devwork-versions
 
 This is a personal project but issues and suggestions are welcome. The image is rebuilt weekly with the latest security updates and Oh My Zsh plugins.
 
+To set up the pre-commit hook that auto-formats shell scripts:
+
+```bash
+git config core.hooksPath .githooks
+```
+
 ## License
 
 MIT License - See LICENSE file for details.

devwork-versions

@@ -4,16 +4,16 @@
 
 # Helper function to safely get version or return NOT FOUND
 get_version() {
-    tool_name="$1"
-    version_cmd="$2"
+  tool_name="$1"
+  version_cmd="$2"
 
-    if command -v "$(echo "$version_cmd" | awk '{print $1}')" >/dev/null 2>&1; then
-        version=$(eval "$version_cmd" 2>&1 | head -1 || echo "ERROR")
-    else
-        version="NOT FOUND"
-    fi
+  if command -v "$(echo "$version_cmd" | awk '{print $1}')" >/dev/null 2>&1; then
+    version=$(eval "$version_cmd" 2>&1 | head -1 || echo "ERROR")
+  else
+    version="NOT FOUND"
+  fi
 
-    printf "%-12s %s\n" "$tool_name:" "$version"
+  printf "%-12s %s\n" "$tool_name:" "$version"
 }
 
 # Display versions

format.sh

@@ -0,0 +1,61 @@
+#!/bin/sh
+# format.sh - Format shell scripts using shfmt
+# Requires: docker (uses mvdan/shfmt container image)
+#
+# Usage:
+#   ./format.sh        Format all shell scripts
+#   ./format.sh -s     Format only staged files and re-stage them (git hook)
+#   ./format.sh -c     Check formatting without writing (CI)
+
+set -e
+
+ALL_SHELL_FILES=".profile devwork-versions test.sh format.sh"
+CHECK=false
+STAGED_ONLY=false
+
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+RED='\033[0;31m'
+NC='\033[0m'
+
+log() { printf "${GREEN}[✔]${NC} %s\n" "$1"; }
+err() { printf "${RED}[✘]${NC} %s\n" "$1"; }
+
+while getopts "cs" opt; do
+  case $opt in
+    c) CHECK=true ;;
+    s) STAGED_ONLY=true ;;
+    *) printf "Usage: %s [-c] [-s]\n" "$0" && exit 1 ;;
+  esac
+done
+
+if ! command -v docker >/dev/null 2>&1; then
+  err "docker not found"
+  exit 1
+fi
+
+if $STAGED_ONLY; then
+  STAGED=$(git diff --cached --name-only)
+  FILES=""
+  for f in $ALL_SHELL_FILES; do
+    echo "$STAGED" | grep -qx "$f" && FILES="$FILES $f"
+  done
+else
+  FILES=$ALL_SHELL_FILES
+fi
+
+if $CHECK; then
+  printf "\n${YELLOW}==> Checking shell script formatting (shfmt)${NC}\n"
+  SHFMT_FLAGS="-l"
+else
+  printf "\n${YELLOW}==> Formatting shell scripts (shfmt)${NC}\n"
+  SHFMT_FLAGS="-w"
+fi
+
+for f in $FILES; do
+  [ -f "$f" ] || continue
+  # shellcheck disable=SC2086
+  docker run --rm -u "$(id -u):$(id -g)" -v "$PWD:/mnt" -w /mnt mvdan/shfmt:v3 $SHFMT_FLAGS -i 2 -ci "$f"
+  $STAGED_ONLY && git add "$f"
+  log "$f"
+done

test.sh

@@ -17,46 +17,46 @@ GREEN='\033[0;32m'
 YELLOW='\033[1;33m'
 NC='\033[0m'
 
-log()  { printf "${GREEN}[✔]${NC} %s\n" "$1"; }
+log() { printf "${GREEN}[✔]${NC} %s\n" "$1"; }
 warn() { printf "${YELLOW}[!]${NC} %s\n" "$1"; }
-err()  { printf "${RED}[✘]${NC} %s\n" "$1"; }
+err() { printf "${RED}[✘]${NC} %s\n" "$1"; }
 
 # --- Shellcheck ---
 printf "\n${YELLOW}==> Linting shell scripts${NC}\n"
 if command -v shellcheck >/dev/null 2>&1; then
-    shellcheck devwork-versions .profile && log "shellcheck passed" || warn "shellcheck reported issues"
+  shellcheck devwork-versions .profile && log "shellcheck passed" || warn "shellcheck reported issues"
 else
-    warn "shellcheck not installed, skipping lint"
+  warn "shellcheck not installed, skipping lint"
 fi
 
 # --- Build & test each version ---
 for VERSION in $VERSIONS; do
-    printf "\n${YELLOW}==> Node.js $VERSION${NC}\n"
-    TAG="devwork:$VERSION-node"
+  printf "\n${YELLOW}==> Node.js $VERSION${NC}\n"
+  TAG="devwork:$VERSION-node"
 
-    # Build
-    printf "Building $TAG...\n"
-    if docker build --build-arg NODE_VERSION="$VERSION" -t "$TAG" .; then
-        log "Build succeeded"
-    else
-        err "Build failed for Node $VERSION"
-        FAIL=$((FAIL + 1))
-        continue
-    fi
+  # Build
+  printf "Building $TAG...\n"
+  if docker build --build-arg NODE_VERSION="$VERSION" -t "$TAG" .; then
+    log "Build succeeded"
+  else
+    err "Build failed for Node $VERSION"
+    FAIL=$((FAIL + 1))
+    continue
+  fi
 
-    # Test
-    printf "Testing $TAG...\n"
-    if docker run --rm "$TAG" devwork-versions; then
-        log "Tests passed"
-        PASS=$((PASS + 1))
-    else
-        err "Tests failed for Node $VERSION"
-        FAIL=$((FAIL + 1))
-    fi
+  # Test
+  printf "Testing $TAG...\n"
+  if docker run --rm "$TAG" devwork-versions; then
+    log "Tests passed"
+    PASS=$((PASS + 1))
+  else
+    err "Tests failed for Node $VERSION"
+    FAIL=$((FAIL + 1))
+  fi
 
-    # Size report
-    SIZE=$(docker images --format "{{.Size}}" "$TAG" | head -1)
-    log "Image size: $SIZE"
+  # Size report
+  SIZE=$(docker images --format "{{.Size}}" "$TAG" | head -1)
+  log "Image size: $SIZE"
 done
 
 # --- Summary ---