chore: 🔧 add comments

Author: Thomas G.

src/common-utils/_configure-feature.sh

@@ -22,16 +22,22 @@ export source=${source:-/usr/local/share/$feature}
 # Get the indent size from devcontainer.json with jq, default to 2 if not found
 export tabSize=4
 
-echo "Configuring feature <${Purple}$feature${None}>${End}"
-echo "from <$source>${End}"
+zz_log i "Configure feature <{Purple $feature}>"
+zz_log - "From {U $source}"
 
 # Go to the module root
 cd "$(git rev-parse --show-toplevel)" >/dev/null
 
+# Ensure the source directory exists
+if [ ! -d $source ]; then
+    zz_log e "Source directory <$source> does not exist"
+    exit 1
+fi
+
 # Deploy stubs if existing
 if [ -d $source/stubs ]; then
 
-    echo "${Blue}Deploy stubs${End}"
+    zz_log i "Deploy stubs"
 
     find $source/stubs -type f -name ".*" -o -type f | while read file; do
 
@@ -50,14 +56,15 @@ if [ -d $source/stubs ]; then
             # Remove # occurrences in the file path
             dest=$(echo $dest | sed 's/\/\#/\//g')
 
-            echo "Add '$dest' to .gitignore${End}"
+            # Add to .gitignore if not already there
+            zz_log i "Add {U $dest} to .gitignore"
 
             # Add to .gitignore if not already there
             grep -qxF $dest .gitignore || echo -e "$dest" >>.gitignore
         fi
 
         # Merge the file
-        echo -e "${Yellow}Merging '$dest'...${End}"
+        zz_log i "Merge {U $file} in {U $dest}"
         git merge-file -p -L current -L base -L stubs $dest /dev/null $file >$dest
 
         # Apply the same permissions as the original file
@@ -67,30 +74,29 @@ if [ -d $source/stubs ]; then
 fi
 
 # Log the merging process
-echo "${Blue}Merge all package folder json files into top level xxx.json${End}"
+zz_log i "Merge all package folder json files into top level xxx.json"
 
 for package in package composer; do
 
     # Create package.json if it does not exist or is empty
     if [ ! -f $package.json -o ! -s $package.json ]; then
         # Create an empty package.json
         echo "{}" >$package.json
-    else
-        # Pre-sort the existing package.json
-        echo "${Yellow}Pre-merge normalize $package.json${End}"
-        normalize-json -s -a -i -t ${tabSize:-4} $package.json
     fi
 
     # Merge all package folder json files into the top-level package.json
     find $source -maxdepth 1 -name _*.$package.json | sort | while read file; do
-        echo "${Yellow}Merge $file in $package.json${End}"
+        zz_log i "Merge {U $file} in {U $package.json}"
         jq --indent ${tabSize:-4} -s '.[0] * .[1]' $file $package.json >/tmp/$package.json && mv -f /tmp/$package.json $package.json
     done
 
+    # Post merge normalize package.json
+    zz_log i "Post-merge normalize {U $package.json}"
+    normalize-json -s -a -i -t ${tabSize:-4} $package.json
 done
 
 # Call all configure-xxx.sh scripts
 find $source -maxdepth 1 -name configure-*.sh | sort | while read file; do
-    echo "${Yellow}Run $file${End}"
+    zz_log i "Run {U $file}"
     $file
 done

src/common-utils/_normalize-json.sh

@@ -27,7 +27,7 @@ zz_log i "Normalizing JSON..."
 list=$(validate-json ${allow:+-a} ${debug:+-d} ${fallback:+-f "$fallback"} ${local:+-l "$local"} ${import:+-i} "$json" "$schema")
 
 if test -z "$list"; then
-    zz_log e "JSON not valid, cannot normalize" && exit 1
+    zz_log e "JSON {U $json} not valid, cannot normalize" && exit 1
 fi
 
 # Normalize JSON
@@ -63,6 +63,9 @@ if test -s /tmp/$$.json; then
     else
         jq -M --indent ${tabSize:-4} . /tmp/$$.json >$json
     fi
+    zz_log s "File {U $json} normalized"
+else
+    zz_log e "File {U $json} not normalized"
 fi
 
 # Clean up

src/common-utils/_validate-json.sh

@@ -519,7 +519,7 @@ fi
 
 # Validate JSON according to schema and display valid json paths
 if validate "$json" "$schema"; then
-    zz_log s "JSON is valid and normalized"
+    zz_log s "File {U $json} valid"
 else
-    zz_log e "JSON is empty or invalid" && exit 1
+    zz_log e "File {U $json} empty or invalid" && exit 1
 fi | sed -n -e 's/^.//g' -e '/^$/d' -e 'G; s/\n/&&/; /^\([ -~]*\n\).*\n\1/d; s/\n//; h; P'

src/common-utils/_zz_args.sh

@@ -105,6 +105,13 @@ else
         fi
     done
 
+    # Process remaining '=' parameters
+    for arg in $(echo $varnames | grep -E "^=" | cut -f2); do
+        if [ "$#" -gt "0" ]; then
+            echo "$arg=$1" && shift 1
+        fi
+    done
+
     # Process remaining '+' parameters
     for arg in $(echo $varnames | grep -E "^\+" | cut -f2); do
         if [ "$#" -gt "0" ]; then

src/common-utils/_zz_log.sh

@@ -7,31 +7,31 @@ lvl="$1" && shift
 
 case $lvl in
 i*)
-    picto="→"
-    base="Blue"
+    picto="{BBlue →} "
+    base="White"
     ;;
 w*)
-    picto="!"
+    picto="{BYellow !} "
     base="Yellow"
     ;;
 e*)
-    picto="✕"
+    picto="{BRed ✕} "
     base="Red"
     ;;
 s*)
-    picto="✔"
+    picto="{BGreen ✔} "
     base="Green"
     ;;
+-)
+    picto=""
+    base="White"
+    ;;
 *)
-    picto="$lvl"
+    picto="$lvl "
     base="White"
     ;;
 esac
 
 eval "$(
-    if [ -n "$picto" ]; then
-        echo "echo \"{B $picto} $*\${End}\""
-    else
-        echo "echo \"$*\${End}\""
-    fi | sed -E "s/\{([A-Z]) /{\1${base} /g;s/\{([a-zA-Z]+) ([^}]*)\}/\${\1}\2\${${base}}/g; s/\r//g; "
+    echo "echo \"$picto$*\${End}\"" | sed -E "s/\{([A-Z]) /{\1${base} /g;s/\{([a-zA-Z]+) ([^}]*)\}/\${\1}\2\${${base}}/g; s/\r//g; "
 )" >&2

src/common-utils/devcontainer-feature.json

@@ -1,6 +1,6 @@
 {
     "name": "Common Utils",
-    "version": "3.4.0",
+    "version": "3.4.1",
     "description": "Common utils for tomgrv/devcontainer-features",
     "dependsOn": {
         "ghcr.io/devcontainers/features/common-utils": {}