🔧 Add pnpm package manager to streamline startup and update cypress docker image version to 13.14.2v4

- Install pnpm in cypress docker container
- Add config variable to .env and set default to pnpm
- Update docker image  version to 13.14.2v4

Author: LadySolveig

.gitignore

@@ -14,4 +14,5 @@ data/sites/*
 **/output
 **/import
 **/tests/cypress/downloads/**
-!visual-regression/import/sitemap.csv.example
+!visual-regression/import/sitemap.csv.example
+**/.pnpm-store

.tools/.env

@@ -1,4 +1,4 @@
-IMAGE_NAME_TAG=joomla-cypress-included:13.14.2v3
+IMAGE_NAME_TAG=joomla-cypress-included:13.14.2v4
 WEB_IMAGE_NAME_TAG=joomla-cypress-web:php-8.3
 
 WEB_LOCAL_PORT=8080
@@ -10,5 +10,8 @@ JC_OVERRIDE_BACKUP=yes
 # Options smart, always
 NPM_DEPS_INSTALL=smart
 
+# Options pnpm, npm
+PACKAGE_MANAGER_PREFS=pnpm
+
 # Default test project
 DEFAULT_TEST_PROJECT=cms

.tools/build/Dockerfile

@@ -32,6 +32,9 @@ RUN set -ex; \
     # apt-get install -y \
     # codium;
 
+# Install pnpm as alternative package manager
+RUN npm install -g pnpm
+
 # Install Sublime Text
 RUN wget -qO - https://download.sublimetext.com/sublimehq-pub.gpg | gpg --dearmor | tee /etc/apt/trusted.gpg.d/sublimehq-archive.gpg > /dev/null
 RUN echo "deb https://download.sublimetext.com/ apt/stable/" | tee /etc/apt/sources.list.d/sublime-text.list

.tools/build/build.sh

@@ -8,7 +8,7 @@
 
 set e+x
 
-LOCAL_NAME=joomla-cypress-included:13.14.2v3
+LOCAL_NAME=joomla-cypress-included:13.14.2v4
 BUILD_PATH=${BUILD:-.}
 
 echo "Building $LOCAL_NAME"

.tools/build/entrypoint.sh

@@ -39,6 +39,28 @@ copyConfig() {
   cp -f $TOOLS_ROOT/config/cypress.config.dist.mjs $WORKDIR/tests/cypress.config.mjs
 }
 
+# Install dependencies
+installDependencies() {
+  cd $WORKDIR/tests/
+
+  if [ ${PACKAGE_MANAGER_PREFS:-npm} == 'pnpm' ]; then
+    if [ ! -f $WORKDIR/tests/pnpm-lock.yaml ] && [ -f $WORKDIR/tests/package-lock.json ]; then
+      pnpm import package-lock.json
+    fi
+    if [ ! -f $WORKDIR/tests/pnpm-lock.yaml ]; then
+      pnpm install
+    else
+      pnpm install --frozen-lockfile
+    fi
+  else
+    if [ ! -f $WORKDIR/tests/package-lock.json ]; then
+      npm i
+    else
+      npm ci
+    fi
+  fi
+}
+
 # Setup configuration file
 # Backup the original file if a backup file not already exists and .env variable is not set to false/no/0
 # Copy the configuration file to the working directory if .env variable is set to true/yes
@@ -162,36 +184,45 @@ if [ ! -f $WORKDIR/tests/package.json ]; then
   echo "[ATTENTION] No package.json found in the tests folder. A general default one will be injected."
   cp -f $TOOLS_ROOT/config/package.json $WORKDIR/tests/package.json
   cp -f $TOOLS_ROOT/config/package-lock.json $WORKDIR/tests/package-lock.json
+  cp -f $TOOLS_ROOT/config/pnpm-lock.yaml $WORKDIR/tests/pnpm-lock.yaml
 fi
 
 # Set the correct permissions
-chown node:node $WORKDIR/tests/package.json $WORKDIR/tests/package-lock.json
+chown node:node $WORKDIR/tests/package.json
+
+if [ -f $WORKDIR/tests/pnpm-lock.yaml ]; then
+  chown node:node $WORKDIR/tests/pnpm-lock.yaml
+fi
+
+if [ -f $WORKDIR/tests/package-lock.json ]; then
+  chown node:node $WORKDIR/tests/package-lock.json
+fi
 
 # Install the assets
 if [ -f $WORKDIR/tests/package.json ]; then
   case ${NPM_DEPS_INSTALL:-smart} in
     always)
       echo "Cleaning the assets"
       rm -rf $WORKDIR/tests/node_modules
+      if [ ${PACKAGE_MANAGER_PREFS:-npm} == 'pnpm' ]; then
+        cd $WORKDIR/tests && pnpm store prune
+      fi
       echo -e " > Installing the assets (takes a while!)"
-      cd $WORKDIR/tests/
-      npm ci
+      installDependencies
       ;;
     *)
       if [ ! -d $WORKDIR/tests/node_modules ]; then
         echo -e " > Installing the assets (takes a while!)"
-        cd $WORKDIR/tests/
-        npm ci
+        installDependencies
       elif [ -d $WORKDIR/tests/node_modules ] && [[ $(find "$WORKDIR/tests/node_modules" -type d -mtime +1 -print) ]]; then
         echo "Assets already installed but older than 1 day"
         echo "Cleaning the assets"
         rm -rf $WORKDIR/tests/node_modules
         echo -e " > Installing the assets (takes a while!)"
-        cd $WORKDIR/tests/
-        npm ci
+        installDependencies
       else
         echo "Assets already installed"
-        echo "Skipping npm install"
+        echo "Skipping ${PACKAGE_MANAGER_PREFS:-npm} install"
       fi
       ;;
   esac