@eeacms/volto-slate-metadata-mentions 8.2.0 → 9.0.0

package/CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [9.0.0](https://github.com/eea/volto-slate-metadata-mentions/compare/8.3.0...9.0.0) - 30 March 2026
+
+#### :rocket: New Features
+
+- feat: Volto 18 support - refs #287700 [Alin Voinea - [`abb36e4`](https://github.com/eea/volto-slate-metadata-mentions/commit/abb36e4aff038c49bf9b567badc20446f1154921)]
+
+#### :house: Internal changes
+
+
+#### :hammer_and_wrench: Others
+
+- test: Fix make test [Alin V. (Claudiu) - [`abc4402`](https://github.com/eea/volto-slate-metadata-mentions/commit/abc4402128767dbe0dc55c04f45f16a7e9ab6b96)]
+- tests: Fix Sonar Qube tags - refs #297339 [Alin Voinea - [`6718de5`](https://github.com/eea/volto-slate-metadata-mentions/commit/6718de5f13f61ca8c8ca65d404b75034e9a07f8f)]
+### [8.3.0](https://github.com/eea/volto-slate-metadata-mentions/compare/8.2.0...8.3.0) - 1 May 2025
+
+#### :bug: Bug Fixes
+
+- fix: subjects widget - refs #284007 [Alin Voinea - [`8b46168`](https://github.com/eea/volto-slate-metadata-mentions/commit/8b46168a36454ac529ddbee7c83a60bc3a34faca)]
+- fix: creators and contributors display full name - refs #284007 [Teodor Voicu - [`5a89152`](https://github.com/eea/volto-slate-metadata-mentions/commit/5a89152ac52db83a1d2597c6a3acdc92996dfbec)]
+
+#### :hammer_and_wrench: Others
+
+- test: Fix unit tests [Alin Voinea - [`3e01041`](https://github.com/eea/volto-slate-metadata-mentions/commit/3e010415b1d10da4f2b29f4e3508a657cd2a8c23)]
 ### [8.2.0](https://github.com/eea/volto-slate-metadata-mentions/compare/8.1.1...8.2.0) - 13 September 2024
 
 #### :rocket: New Features

package/DEVELOP.md

@@ -26,21 +26,20 @@
 
 ### Or add @eeacms/volto-slate-metadata-mentions to your Volto project
 
-Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
+Before starting make sure your development environment is properly set. See the official Plone documentation for [creating a project with Cookieplone](https://6.docs.plone.org/install/create-project-cookieplone.html) and [installing an add-on in development mode in Volto 18 and 19](https://6.docs.plone.org/volto/development/add-ons/install-an-add-on-dev-18.html).
 
-1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
+For new Volto 18+ projects, use Cookieplone. It includes `mrs-developer` by default.
 
-        npm install -g yo @plone/generator-volto mrs-developer
+1.  Create a new Volto project with Cookieplone
 
-1.  Create new volto app
-
-        yo @plone/volto my-volto-project --addon @eeacms/volto-slate-metadata-mentions --skip-install
-        cd my-volto-project
+        uvx cookieplone project
+        cd project-title
 
 1.  Add the following to `mrs.developer.json`:
 
         {
             "volto-slate-metadata-mentions": {
+                "output": "packages",
                 "url": "https://github.com/eea/volto-slate-metadata-mentions.git",
                 "package": "@eeacms/volto-slate-metadata-mentions",
                 "branch": "develop",
@@ -48,28 +47,31 @@ Before starting make sure your development environment is properly set. See [Vol
             }
         }
 
-1.  Install
+1.  Add `@eeacms/volto-slate-metadata-mentions` to the `addons` key in your project `volto.config.js`
+
+1.  Install or refresh the project setup
 
-        make develop
-        yarn
+        make install
 
-1.  Start backend
+1.  Start backend in one terminal
 
-        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
+        make backend-start
 
-    ...wait for backend to setup and start - `Ready to handle requests`:
+    ...wait for backend to setup and start, ending with `Ready to handle requests`
 
     ...you can also check http://localhost:8080/Plone
 
-1.  Start frontend
+1.  Start frontend in a second terminal
 
-        yarn start
+        make frontend-start
 
 1.  Go to http://localhost:3000
 
 1.  Happy hacking!
 
-        cd src/addons/volto-slate-metadata-mentions/
+        cd packages/volto-slate-metadata-mentions
+
+For legacy Volto 17 projects, keep using the yarn-based workflow from the Volto 17 documentation.
 
 ## Cypress
 
@@ -81,7 +83,7 @@ project where you added `volto-slate-metadata-mentions` to `mrs.developer.json`
 Go to:
 
   ```BASH
-  cd src/addons/volto-slate-metadata-mentions/
+  cd packages/volto-slate-metadata-mentions/
   ```
 
 Start:

package/Dockerfile

@@ -1,13 +1,22 @@
 # syntax=docker/dockerfile:1
 ARG VOLTO_VERSION
-FROM eeacms/frontend-builder:${VOLTO_VERSION}
+FROM plone/frontend-builder:${VOLTO_VERSION}
 
 ARG ADDON_NAME
 ARG ADDON_PATH
+ENV HOST="0.0.0.0"
+
+USER root
+RUN apt-get update -q \
+    && apt-get install -qy --no-install-recommends \
+       chromium libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libgconf-2-4 libnss3 libxss1 libasound2 libxtst6 xauth xvfb \
+    && rm -rf /var/lib/apt/lists/*
+USER node
 
 COPY --chown=node:node ./ /app/src/addons/${ADDON_PATH}/
 
 RUN /setupAddon
+RUN yarn add jest-junit
 RUN yarn install
 
 ENTRYPOINT ["yarn"]

package/Jenkinsfile

@@ -1,7 +1,4 @@
 pipeline {
-  tools {
-    jdk 'Java17'
-  }
   agent {
     node { label 'docker-host' }
   }
@@ -9,12 +6,12 @@ pipeline {
   environment {
     GIT_NAME = "volto-slate-metadata-mentions"
     NAMESPACE = "@eeacms"
-    SONARQUBE_TAGS = "volto.eea.europa.eu,biodiversity.europa.eu,www.eea.europa.eu-ims,climate-energy.eea.europa.eu,forest.eea.europa.eu,clms.land.copernicus.eu,industry.eea.europa.eu,water.europa.eu-freshwater,demo-www.eea.europa.eu,clmsdemo.devel6cph.eea.europa.eu,water.europa.eu-marine,climate-adapt.eea.europa.eu,climate-advisory-board.devel4cph.eea.europa.eu,climate-advisory-board.europa.eu,www.eea.europa.eu-en,insitu-frontend.eionet.europa.eu,insitu.copernicus.eu"
+    SONARQUBE_TAGS = "volto.eea.europa.eu,biodiversity.europa.eu,climate-energy.eea.europa.eu,forest.eea.europa.eu,industry.eea.europa.eu,water.europa.eu-freshwater,demo-www.eea.europa.eu,clmsdemo.devel6cph.eea.europa.eu,water.europa.eu-marine,climate-adapt.eea.europa.eu,climate-advisory-board.devel4cph.eea.europa.eu,climate-advisory-board.europa.eu,www.eea.europa.eu-en,www.eea.europa.eu,insitu.copernicus.eu,ask.copernicus.eu,land.copernicus.eu"
     DEPENDENCIES = ""
     BACKEND_PROFILES = "eea.kitkat:testing"
     BACKEND_ADDONS = ""
     VOLTO = "17"
-    VOLTO16_BREAKING_CHANGES = "no"
+    VOLTO18_BREAKING_CHANGES = "no"
     IMAGE_NAME = BUILD_TAG.toLowerCase()
   }
 
@@ -166,8 +163,7 @@ pipeline {
                 script {
                   try {
                     sh '''docker run --pull always --rm -d --name="$IMAGE_NAME-plone" -e SITE="Plone" -e PROFILES="$BACKEND_PROFILES" -e ADDONS="$BACKEND_ADDONS" eeacms/plone-backend'''
-                    sh '''docker run -d --shm-size=6g --link $IMAGE_NAME-plone:plone --name="$IMAGE_NAME-cypress" -e "RAZZLE_INTERNAL_API_PATH=http://plone:8080/Plone" --entrypoint=make --workdir=/app/src/addons/$GIT_NAME $IMAGE_NAME-frontend start-ci'''
-                    sleep 30
+                    sh '''docker run -d --shm-size=4g --link $IMAGE_NAME-plone:plone --name="$IMAGE_NAME-cypress" -e "RAZZLE_INTERNAL_API_PATH=http://plone:8080/Plone" --entrypoint=make --workdir=/app/src/addons/$GIT_NAME $IMAGE_NAME-frontend start-ci'''
                     frontend = sh script:'''docker exec --workdir=/app/src/addons/${GIT_NAME} $IMAGE_NAME-cypress make check-ci''', returnStatus: true
                     if ( frontend != 0 ) {
                       sh '''docker logs $IMAGE_NAME-cypress; exit 1'''
@@ -243,11 +239,17 @@ pipeline {
         script {
           def scannerHome = tool 'SonarQubeScanner'
           def nodeJS = tool 'NodeJS'
+          if (env.CHANGE_ID) {
+            env.sonarParams = " -Dsonar.pullrequest.base=${env.CHANGE_TARGET} -Dsonar.pullrequest.branch=${env.CHANGE_BRANCH} -Dsonar.pullrequest.key=${env.CHANGE_ID} "
+          }
+          else {
+            env.sonarParams = " -Dsonar.branch.name=${env.BRANCH_NAME}"
+          }
           withSonarQubeEnv('Sonarqube') {
             sh '''sed -i "s#/app/src/addons/${GIT_NAME}/##g" xunit-reports/coverage/lcov.info'''
             sh '''sed -i "s#src/addons/${GIT_NAME}/##g" xunit-reports/coverage/lcov.info'''
-            sh "export PATH=${scannerHome}/bin:${nodeJS}/bin:$PATH; sonar-scanner -Dsonar.javascript.lcov.reportPaths=./xunit-reports/coverage/lcov.info,./cypress-coverage/coverage/lcov.info -Dsonar.sources=./src -Dsonar.projectKey=$GIT_NAME-$BRANCH_NAME -Dsonar.projectVersion=$BRANCH_NAME-$BUILD_NUMBER"
-            sh '''try=5; while [ \$try -gt 0 ]; do curl -s -XPOST -u "${SONAR_AUTH_TOKEN}:" "${SONAR_HOST_URL}api/project_tags/set?project=${GIT_NAME}-${BRANCH_NAME}&tags=${SONARQUBE_TAGS},${BRANCH_NAME}" > set_tags_result; if [ \$(grep -ic error set_tags_result ) -eq 0 ]; then try=0; else cat set_tags_result; echo "... Will retry"; sleep 15; try=\$(( \$try - 1 )); fi; done'''
+            sh "export PATH=${scannerHome}/bin:${nodeJS}/bin:$PATH; sonar-scanner -Dsonar.javascript.lcov.reportPaths=./xunit-reports/coverage/lcov.info,./cypress-coverage/coverage/lcov.info -Dsonar.sources=./src -Dsonar.projectKey=$GIT_NAME -Dsonar.projectName=$GIT_NAME -Dsonar.projectVersion=\$(jq -r '.version' package.json) ${env.sonarParams}"
+            sh '''try=5; while [ \$try -gt 0 ]; do curl -s -XPOST -u "${SONAR_AUTH_TOKEN}:" "${SONAR_HOST_URL}api/project_tags/set?project=${GIT_NAME}&tags=${SONARQUBE_TAGS}" > set_tags_result; if [ \$(grep -ic error set_tags_result ) -eq 0 ]; then try=0; else cat set_tags_result; echo "... Will retry"; sleep 15; try=\$(( \$try - 1 )); fi; done'''
           }
         }
       }
@@ -257,75 +259,75 @@ pipeline {
         }
       }
 
-      stage('Volto 16') { 
+      stage('Volto 18') { 
         agent { node { label 'integration'} }
         when { 
           environment name: 'SKIP_TESTS', value: ''
-          not { environment name: 'VOLTO16_BREAKING_CHANGES', value: 'yes' }
+          not { environment name: 'VOLTO18_BREAKING_CHANGES', value: 'yes' }
         }
         stages {
       		stage('Build test image') {
             steps {
-              sh '''docker build --pull --build-arg="VOLTO_VERSION=16" --build-arg="ADDON_NAME=$NAMESPACE/$GIT_NAME"  --build-arg="ADDON_PATH=$GIT_NAME" . -t $IMAGE_NAME-frontend16'''
+              sh '''docker build --pull --build-arg="VOLTO_VERSION=18-yarn" --build-arg="ADDON_NAME=$NAMESPACE/$GIT_NAME"  --build-arg="ADDON_PATH=$GIT_NAME" . -t $IMAGE_NAME-frontend18'''
             }
           }
 
-             stage('Unit tests Volto 16') {
+             stage('Unit tests Volto 18') {
               steps {
                 script {
                   try {
-                    sh '''docker run --name="$IMAGE_NAME-volto16" --entrypoint=make --workdir=/app/src/addons/$GIT_NAME $IMAGE_NAME-frontend16 test-ci'''
-                    sh '''rm -rf xunit-reports16'''
-                    sh '''mkdir -p xunit-reports16'''
-                    sh '''docker cp $IMAGE_NAME-volto16:/app/junit.xml xunit-reports16/'''
+                    sh '''docker run --name="$IMAGE_NAME-volto18" --entrypoint=make --workdir=/app/src/addons/$GIT_NAME $IMAGE_NAME-frontend18 test-ci'''
+                    sh '''rm -rf xunit-reports18'''
+                    sh '''mkdir -p xunit-reports18'''
+                    sh '''docker cp $IMAGE_NAME-volto18:/app/junit.xml xunit-reports18/'''
                 } finally {
                     catchError(buildResult: 'SUCCESS', stageResult: 'SUCCESS') {
-                        junit testResults: 'xunit-reports16/junit.xml', allowEmptyResults: true
+                        junit testResults: 'xunit-reports18/junit.xml', allowEmptyResults: true
                     }
-                    sh script: '''docker rm -v $IMAGE_NAME-volto16''', returnStatus: true
+                    sh script: '''docker rm -v $IMAGE_NAME-volto18''', returnStatus: true
                   }
                 }
               }
             }
 
-           stage('Integration tests Volto 16') {
+           stage('Integration tests Volto 18') {
               steps {
                 script {
                   try {
-                    sh '''docker run --pull always --rm -d --name="$IMAGE_NAME-plone16" -e SITE="Plone" -e PROFILES="$BACKEND_PROFILES" -e ADDONS="$BACKEND_ADDONS" eeacms/plone-backend'''
-                    sh '''docker run -d --shm-size=4g --link $IMAGE_NAME-plone16:plone --name="$IMAGE_NAME-cypress16" -e "RAZZLE_INTERNAL_API_PATH=http://plone:8080/Plone" --entrypoint=make --workdir=/app/src/addons/$GIT_NAME $IMAGE_NAME-frontend16 start-ci'''
-                    frontend = sh script:'''docker exec --workdir=/app/src/addons/${GIT_NAME} $IMAGE_NAME-cypress16 make check-ci''', returnStatus: true
+                    sh '''docker run --pull always --rm -d --name="$IMAGE_NAME-plone18" -e SITE="Plone" -e PROFILES="$BACKEND_PROFILES" -e ADDONS="$BACKEND_ADDONS" eeacms/plone-backend'''
+                    sh '''docker run -d --shm-size=4g --link $IMAGE_NAME-plone18:plone --name="$IMAGE_NAME-cypress18" -e "RAZZLE_INTERNAL_API_PATH=http://plone:8080/Plone" --entrypoint=make --workdir=/app/src/addons/$GIT_NAME $IMAGE_NAME-frontend18 start-ci'''
+                    frontend = sh script:'''docker exec --workdir=/app/src/addons/${GIT_NAME} $IMAGE_NAME-cypress18 make check-ci''', returnStatus: true
                     if ( frontend != 0 ) {
-                      sh '''docker logs $IMAGE_NAME-cypress16; exit 1'''
+                      sh '''docker logs $IMAGE_NAME-cypress18; exit 1'''
                     }
-                    sh '''timeout -s 9 1800 docker exec --workdir=/app/src/addons/${GIT_NAME} $IMAGE_NAME-cypress16 make cypress-ci'''
+                    sh '''timeout -s 9 1800 docker exec --workdir=/app/src/addons/${GIT_NAME} $IMAGE_NAME-cypress18 make cypress-ci'''
                   } finally {
                     try {
                       if ( frontend == 0 ) {
-                      sh '''rm -rf cypress-videos16 cypress-results16 cypress-coverage16 cypress-screenshots16'''
-                      sh '''mkdir -p cypress-videos16 cypress-results16 cypress-coverage16 cypress-screenshots16'''
-                      videos = sh script: '''docker cp $IMAGE_NAME-cypress16:/app/src/addons/$GIT_NAME/cypress/videos cypress-videos16/''', returnStatus: true
-                      sh '''docker cp $IMAGE_NAME-cypress16:/app/src/addons/$GIT_NAME/cypress/reports cypress-results16/'''
-                      screenshots = sh script: '''docker cp $IMAGE_NAME-cypress16:/app/src/addons/$GIT_NAME/cypress/screenshots cypress-screenshots16''', returnStatus: true
+                      sh '''rm -rf cypress-videos18 cypress-results18 cypress-coverage18 cypress-screenshots18'''
+                      sh '''mkdir -p cypress-videos18 cypress-results18 cypress-coverage18 cypress-screenshots18'''
+                      videos = sh script: '''docker cp $IMAGE_NAME-cypress18:/app/src/addons/$GIT_NAME/cypress/videos cypress-videos18/''', returnStatus: true
+                      sh '''docker cp $IMAGE_NAME-cypress18:/app/src/addons/$GIT_NAME/cypress/reports cypress-results18/'''
+                      screenshots = sh script: '''docker cp $IMAGE_NAME-cypress18:/app/src/addons/$GIT_NAME/cypress/screenshots cypress-screenshots18''', returnStatus: true
 
-                      archiveArtifacts artifacts: 'cypress-screenshots16/**', fingerprint: true, allowEmptyArchive: true
+                      archiveArtifacts artifacts: 'cypress-screenshots18/**', fingerprint: true, allowEmptyArchive: true
 
                       if ( videos == 0 ) {
-                        sh '''for file in $(find cypress-results16 -name *.xml); do if [ $(grep -E 'failures="[1-9].*"' $file | wc -l) -eq 0 ]; then testname=$(grep -E 'file=.*failures="0"' $file | sed 's#.* file=".*\\/\\(.*\\.[jsxt]\\+\\)" time.*#\\1#' );  rm -f cypress-videos16/videos/$testname.mp4; fi; done'''
-                        archiveArtifacts artifacts: 'cypress-videos16/**/*.mp4', fingerprint: true, allowEmptyArchive: true
+                        sh '''for file in $(find cypress-results18 -name *.xml); do if [ $(grep -E 'failures="[1-9].*"' $file | wc -l) -eq 0 ]; then testname=$(grep -E 'file=.*failures="0"' $file | sed 's#.* file=".*\\/\\(.*\\.[jsxt]\\+\\)" time.*#\\1#' );  rm -f cypress-videos18/videos/$testname.mp4; fi; done'''
+                        archiveArtifacts artifacts: 'cypress-videos18/**/*.mp4', fingerprint: true, allowEmptyArchive: true
                       }
                       }
                     } finally {
                       catchError(buildResult: 'SUCCESS', stageResult: 'SUCCESS') {
-                        junit testResults: 'cypress-results16/**/*.xml', allowEmptyResults: true
+                        junit testResults: 'cypress-results18/**/*.xml', allowEmptyResults: true
                       }
                       catchError(buildResult: 'SUCCESS', stageResult: 'SUCCESS') {
-                        sh '''docker logs $IMAGE_NAME-cypress16'''
+                        sh '''docker logs $IMAGE_NAME-cypress18'''
                       }
-                      sh script: "docker stop $IMAGE_NAME-cypress16", returnStatus: true
-                      sh script: "docker stop $IMAGE_NAME-plone16", returnStatus: true
-                      sh script: "docker rm -v $IMAGE_NAME-plone16", returnStatus: true
-                      sh script: "docker rm -v $IMAGE_NAME-cypress16", returnStatus: true
+                      sh script: "docker stop $IMAGE_NAME-cypress18", returnStatus: true
+                      sh script: "docker stop $IMAGE_NAME-plone18", returnStatus: true
+                      sh script: "docker rm -v $IMAGE_NAME-plone18", returnStatus: true
+                      sh script: "docker rm -v $IMAGE_NAME-cypress18", returnStatus: true
                     }
                   }
                 }
@@ -338,7 +340,7 @@ pipeline {
       post {
         always {
             sh script: "docker rmi $IMAGE_NAME-frontend", returnStatus: true
-            sh script: "docker rmi $IMAGE_NAME-frontend16", returnStatus: true
+            sh script: "docker rmi $IMAGE_NAME-frontend18", returnStatus: true
         }
       }
     }
@@ -364,7 +366,7 @@ pipeline {
         script {
           sh '''echo "Error" > checkresult.txt'''
           catchError(buildResult: 'FAILURE', stageResult: 'FAILURE') {
-            sh '''set -o pipefail; docker run -i --rm --pull always --name="$IMAGE_NAME-gitflow-sn" -e GIT_BRANCH="$BRANCH_NAME" -e GIT_NAME="$GIT_NAME" eeacms/gitflow /checkSonarqubemaster.sh | grep -v "Found script" | tee checkresult.txt'''
+            sh '''set -o pipefail; docker run -i --rm --pull always --name="$IMAGE_NAME-gitflow-sn" -e GIT_BRANCH="$BRANCH_NAME" -e GIT_NAME="$GIT_NAME" eeacms/gitflow /checkSonarqubemasterV2.sh | grep -v "Found script" | tee checkresult.txt'''
           }
 
           publishChecks name: 'SonarQube', title: 'Sonarqube Code Quality Check', summary: 'Quality check on the SonarQube metrics from branch develop, comparing it with the ones from master branch. No bugs are allowed',
@@ -414,4 +416,3 @@ pipeline {
     }
   }
 }
-

package/Makefile

@@ -23,10 +23,12 @@ SHELL:=bash
 .DELETE_ON_ERROR:
 MAKEFLAGS+=--warn-undefined-variables
 MAKEFLAGS+=--no-builtin-rules
+TERM?=dumb
+export TERM
 
 # Colors
 # OK=Green, warn=yellow, error=red
-ifeq ($(TERM),)
+ifneq ($(shell test -n "$$TERM" && command -v tput >/dev/null 2>&1 && echo yes),yes)
 # no colors if not in terminal
         MARK_COLOR=
         OK_COLOR=
@@ -34,11 +36,11 @@ ifeq ($(TERM),)
         ERROR_COLOR=
         NO_COLOR=
 else
-        MARK_COLOR=`tput setaf 6`
-        OK_COLOR=`tput setaf 2`
-        WARN_COLOR=`tput setaf 3`
-        ERROR_COLOR=`tput setaf 1`
-        NO_COLOR=`tput sgr0`
+        MARK_COLOR:=$(shell tput setaf 6 2>/dev/null || true)
+        OK_COLOR:=$(shell tput setaf 2 2>/dev/null || true)
+        WARN_COLOR:=$(shell tput setaf 3 2>/dev/null || true)
+        ERROR_COLOR:=$(shell tput setaf 1 2>/dev/null || true)
+        NO_COLOR:=$(shell tput sgr0 2>/dev/null || true)
 endif
 
 ##############################################################################
@@ -46,7 +48,7 @@ endif
 DIR=$(shell basename $$(pwd))
 NODE_MODULES?="../../../node_modules"
 PLONE_VERSION?=6
-VOLTO_VERSION?=17
+VOLTO_VERSION?=18-yarn
 ADDON_PATH="${DIR}"
 ADDON_NAME="@eeacms/${ADDON_PATH}"
 DOCKER_COMPOSE=PLONE_VERSION=${PLONE_VERSION} VOLTO_VERSION=${VOLTO_VERSION} ADDON_NAME=${ADDON_NAME} ADDON_PATH=${ADDON_PATH} docker compose
@@ -82,19 +84,19 @@ shell:			## Start a shell in the frontend container
 
 .PHONY: cypress-open
 cypress-open:		## Open cypress integration tests
-	CYPRESS_API_PATH="${RAZZLE_DEV_PROXY_API_PATH}" NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress open
+	TERM="$${TERM:-dumb}" CYPRESS_API_PATH="${RAZZLE_DEV_PROXY_API_PATH}" NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress open
 
 .PHONY: cypress-run
 cypress-run:	## Run cypress integration tests
-	CYPRESS_API_PATH="${RAZZLE_DEV_PROXY_API_PATH}" NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress run
+	TERM="$${TERM:-dumb}" CYPRESS_API_PATH="${RAZZLE_DEV_PROXY_API_PATH}" NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress run
 
 .PHONY: test
 test:			## Run jest tests
-	${DOCKER_COMPOSE} run -e CI=1 frontend test
+	${DOCKER_COMPOSE} run --no-deps -e CI=1 frontend test
 
 .PHONY: test-update
 test-update:	## Update jest tests snapshots
-	${DOCKER_COMPOSE} run -e CI=1 frontend test -u
+	${DOCKER_COMPOSE} run --no-deps -e CI=1 frontend test -u
 
 .PHONY: stylelint
 stylelint:		## Stylelint
@@ -162,4 +164,4 @@ check-ci:
 .PHONY: cypress-ci
 cypress-ci:
 	$(NODE_MODULES)/.bin/wait-on -t 240000  http://localhost:3000
-	CYPRESS_API_PATH="${RAZZLE_DEV_PROXY_API_PATH}" NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress run --browser chromium
+	TERM="$${TERM:-dumb}" CYPRESS_API_PATH="${RAZZLE_DEV_PROXY_API_PATH}" NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress run --browser chromium

package/README.md

@@ -3,16 +3,16 @@
 [![Releases](https://img.shields.io/github/v/release/eea/volto-slate-metadata-mentions)](https://github.com/eea/volto-slate-metadata-mentions/releases)
 
 [![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-slate-metadata-mentions%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-metadata-mentions/job/master/display/redirect)
-[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-master)
-[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-master)
-[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-master)
-[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-master)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions)
 
 [![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-slate-metadata-mentions%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-slate-metadata-mentions/job/develop/display/redirect)
-[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-develop)
-[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-develop)
-[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-develop)
-[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions-develop)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&branch=develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions&branch=develop)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&branch=develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions&branch=develop)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&branch=develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions&branch=develop)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-slate-metadata-mentions&branch=develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-slate-metadata-mentions&branch=develop)
 
 
 [Volto Slate](https://6.dev-docs.plone.org/volto/configuration/volto-slate/) Metadata Mentions
@@ -61,6 +61,11 @@ This version requires: `@plone/volto >= 16.0.0.alpha.15` (`volto-slate` part of
 
 Go to http://localhost:3000
 
+`make start` now defaults to Volto 18. To run the same setup against Volto 17, use:
+
+      VOLTO_VERSION=17 make
+      VOLTO_VERSION=17 make start
+
 ### Add volto-slate-metadata-mentions to your Volto project
 
 1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
@@ -74,30 +79,39 @@ Go to http://localhost:3000
 * If you already have a volto project, just update `package.json`:
 
    ```JSON
-   "addons": [
-       "@eeacms/volto-slate-metadata-mentions"
-   ],
-
    "dependencies": {
        "@eeacms/volto-slate-metadata-mentions": "*"
    }
    ```
 
-* If not, create one:
+   and `volto.config.js`:
+
+   ```JavaScript
+   const addons = ['@eeacms/volto-slate-metadata-mentions'];
+   ```
+
+* If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:
 
    ```
-   npm install -g yo @plone/generator-volto
-   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-slate-metadata-mentions
-   cd my-volto-project
+   uvx cookieplone project
+   cd project-title
    ```
 
-1. Install new add-ons and restart Volto:
+1. Install or update dependencies, then start the project:
 
    ```
-   yarn
-   yarn start
+   make install
    ```
 
+   For a Cookieplone project, start the backend and frontend in separate terminals:
+
+   ```
+   make backend-start
+   make frontend-start
+   ```
+
+   For a legacy Volto 17 project, install the package with `yarn` and restart the frontend as usual.
+
 1. Go to http://localhost:3000
 
 1. Happy editing!

package/cypress/e2e/01-metadata-lifecycle.cy.js

@@ -0,0 +1,44 @@
+import { slateBeforeEach, slateAfterEach } from '../support/e2e';
+import {
+  addMetadataMention,
+  setDescriptionMetadataValue,
+} from '../support/metadata';
+
+describe('Block Tests: Metadata lifecycle', () => {
+  beforeEach(slateBeforeEach);
+  afterEach(slateAfterEach);
+
+  it('allows adding, removing, and re-adding metadata mentions in the editor', () => {
+    cy.getSlateEditorAndType('Colorless green ideas sleep furiously.')
+      .type('{selectAll}')
+      .dblclick();
+
+    addMetadataMention({
+      cursorText: 'Colorless',
+      selectionStart: 'Colorless',
+      selectionEnd: 'green',
+      metadataLabel: 'Publishing Date',
+    });
+
+    // Click on the mention to select it and show context toolbar
+    cy.get('.slate-editor .metadata.mention.edit').first().click();
+    cy.wait(500);
+    cy.get('.slate-editor .metadata.mention.edit').first().dblclick();
+    cy.clickSlateButton('Remove metadata');
+
+    // Re-focus the editor after removing mention
+    cy.get('.slate-editor.selected [contenteditable=true]').focus().click();
+    cy.wait(500);
+
+    addMetadataMention({
+      cursorText: 'Colorless',
+      selectionStart: 'green',
+      selectionEnd: 'sleep',
+      metadataLabel: 'Summary',
+      setValue: () => setDescriptionMetadataValue('blue cats sleep'),
+    });
+
+    cy.toolbarSave();
+    cy.contains('Colorless blue cats sleep furiously.');
+  });
+});

package/cypress/e2e/02-metadata-summary.cy.js

@@ -0,0 +1,42 @@
+import { slateBeforeEach, slateAfterEach } from '../support/e2e';
+import {
+  addMetadataMention,
+  getMentionNodes,
+  setDescriptionMetadataValue,
+} from '../support/metadata';
+
+const createSummaryMention = (value = 'Mentioned summary') => {
+  cy.getSlateEditorAndType('Alpha beta gamma delta.');
+  addMetadataMention({
+    cursorText: 'Alpha',
+    selectionStart: 'gamma',
+    metadataLabel: 'Summary',
+    setValue: () => setDescriptionMetadataValue(value),
+  });
+};
+
+describe('Block Tests: Metadata summary', () => {
+  beforeEach(slateBeforeEach);
+  afterEach(slateAfterEach);
+
+  it('renders summary metadata mentions after save', () => {
+    createSummaryMention();
+
+    cy.toolbarSave();
+    cy.get('#page-document').should('contain.text', 'Mentioned summary');
+  });
+
+  it('stores summary metadata mention data in the slate JSON', () => {
+    createSummaryMention();
+
+    cy.toolbarSave();
+    getMentionNodes().then((mentions) => {
+      expect(mentions).to.have.length(1);
+      expect(mentions[0].data).to.deep.equal({
+        description: 'Mentioned summary',
+        metadata: 'description',
+        widget: 'description',
+      });
+    });
+  });
+});

package/cypress/e2e/03-metadata-contributors.cy.js

@@ -0,0 +1,42 @@
+import { slateBeforeEach, slateAfterEach } from '../support/e2e';
+import {
+  addMetadataMention,
+  getMentionNodes,
+  setContributorsMetadataValue,
+} from '../support/metadata';
+
+const createContributorsMention = (value = 'John Doe') => {
+  cy.getSlateEditorAndType('Alpha beta gamma delta.');
+  addMetadataMention({
+    cursorText: 'Alpha',
+    selectionStart: 'beta',
+    metadataLabel: 'Contributors',
+    setValue: () => setContributorsMetadataValue(value),
+  });
+};
+
+describe('Block Tests: Metadata contributors', () => {
+  beforeEach(slateBeforeEach);
+  afterEach(slateAfterEach);
+
+  it('renders contributors metadata mentions after save', () => {
+    createContributorsMention();
+
+    cy.toolbarSave();
+    cy.get('#page-document').should('contain.text', 'John Doe');
+  });
+
+  it('stores contributors metadata mention data in the slate JSON', () => {
+    createContributorsMention();
+
+    cy.toolbarSave();
+    getMentionNodes().then((mentions) => {
+      expect(mentions).to.have.length(1);
+      expect(mentions[0].data).to.deep.equal({
+        contributors: ['John Doe'],
+        metadata: 'contributors',
+        widget: 'array',
+      });
+    });
+  });
+});