@eeacms/volto-slate-footnote 6.1.2 → 6.1.3

package/CHANGELOG.md

@@ -4,6 +4,23 @@ 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).
 
+### [6.1.3](https://github.com/eea/volto-slate-footnote/compare/6.1.2...6.1.3) - 30 August 2023
+
+#### :bug: Bug Fixes
+
+- fix: metadata block error - refs #256758 [dobri1408 - [`90cbf4b`](https://github.com/eea/volto-slate-footnote/commit/90cbf4bfdcc19efa8fc316d8a01387813b6768ac)]
+
+#### :house: Documentation changes
+
+- docs: Cleanup Makefile, update DEVELOP documentation, i18n - refs #254894 [valentinab25 - [`64077a5`](https://github.com/eea/volto-slate-footnote/commit/64077a55200a3d35048867ed1816ef1544b86af9)]
+- docs: add docker backend [valentinab25 - [`72280e8`](https://github.com/eea/volto-slate-footnote/commit/72280e87274f52ecfb513d8d7853e2a1a57df6a4)]
+
+#### :hammer_and_wrench: Others
+
+- increase code covreage [Dobricean Ioan Dorian - [`d61c883`](https://github.com/eea/volto-slate-footnote/commit/d61c883df33355c8c79abd1dc2b9e55590f2542b)]
+- test: Fix package.json scripts to use makefile [Alin Voinea - [`e2a4d77`](https://github.com/eea/volto-slate-footnote/commit/e2a4d77e2d750bd1a35b470e7731ccca59c5bbc4)]
+- i18n: Add en [Alin Voinea - [`8a48917`](https://github.com/eea/volto-slate-footnote/commit/8a489177b3a5f11aa742d5213442a67f9cb6b2e9)]
+- test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`86ea0e1`](https://github.com/eea/volto-slate-footnote/commit/86ea0e1034d4b3c8be08a43cf7daf393675898de)]
 ### [6.1.2](https://github.com/eea/volto-slate-footnote/compare/6.1.1...6.1.2) - 24 July 2023
 
 ### [6.1.1](https://github.com/eea/volto-slate-footnote/compare/6.1.0...6.1.1) - 12 June 2023

package/DEVELOP.md

@@ -2,6 +2,28 @@
 
 ## Develop
 
+1. Make sure you have `docker` and `docker compose` installed and running on your machine:
+
+    ```Bash
+    git clone https://github.com/eea/volto-slate-footnote.git
+    cd volto-slate-footnote
+    git checkout -b bugfix-123456 develop
+    make
+    make start
+    ```
+
+1. Wait for `Volto started at 0.0.0.0:3000` meesage
+
+1. Go to http://localhost:3000
+
+1.  Happy hacking!
+
+    ```Bash
+    cd src/addons/volto-slate-footnote/
+    ```
+
+### Or add @eeacms/volto-slate-footnote 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/)
 
 1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
@@ -51,3 +73,37 @@ Before starting make sure your development environment is properly set. See [Vol
 1.  Happy hacking!
 
         cd src/addons/volto-slate-footnote/
+
+## Cypress
+
+To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
+
+You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
+project where you added `volto-slate-footnote` to `mrs.developer.json`
+
+Go to:
+
+  ```BASH
+  cd src/addons/volto-slate-footnote/
+  ```
+
+Start:
+
+  ```Bash
+  make
+  make start
+  ```
+
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-slate-footnote` block installed.
+
+Open Cypress Interface:
+
+  ```Bash
+  make cypress-open
+  ```
+
+Or run it:
+
+  ```Bash
+  make cypress-run
+  ```

package/Dockerfile

@@ -0,0 +1,14 @@
+# syntax=docker/dockerfile:1
+ARG VOLTO_VERSION
+FROM plone/frontend-builder:${VOLTO_VERSION}
+
+ARG ADDON_NAME
+ARG ADDON_PATH
+
+COPY --chown=node:node ./ /app/src/addons/${ADDON_PATH}/
+
+RUN /setupAddon
+RUN yarn install
+
+ENTRYPOINT ["yarn"]
+CMD ["start"]

package/Jenkinsfile

@@ -197,6 +197,31 @@ pipeline {
       }
     }
 
+    stage('SonarQube compare to master') {
+      when {
+        allOf {
+          environment name: 'CHANGE_ID', value: ''
+          branch 'develop'
+          not { changelog '.*^Automated release [0-9\\.]+$' }
+        }
+      }
+      steps {
+        node(label: 'docker') {
+          script {
+            sh '''docker pull eeacms/gitflow'''
+            sh '''echo "Error" > checkresult.txt'''
+            catchError(buildResult: 'FAILURE', stageResult: 'FAILURE') {
+               sh '''set -o pipefail; docker run -i --rm --name="$BUILD_TAG-gitflow-sn" -e GIT_BRANCH="$BRANCH_NAME" -e GIT_NAME="$GIT_NAME" eeacms/gitflow /checkSonarqubemaster.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",
+                          text: readFile(file: 'checkresult.txt'), conclusion: "${currentBuild.currentResult}",
+                          detailsURL: "${env.BUILD_URL}display/redirect"
+          }
+        }
+      }
+    }
+
     stage('Pull Request') {
       when {
         not {

package/Makefile

@@ -1,49 +1,131 @@
-SHELL=/bin/bash
+##############################################################################
+# Run:
+#    make
+#    make start
+#
+# Go to:
+#
+#     http://localhost:3000
+#
+# Cypress:
+#
+#    make cypress-open
+#
+##############################################################################
+# SETUP MAKE
+#
+## Defensive settings for make: https://tech.davis-hansson.com/p/make/
+SHELL:=bash
+.ONESHELL:
+# for Makefile debugging purposes add -x to the .SHELLFLAGS
+.SHELLFLAGS:=-eu -o pipefail -O inherit_errexit -c
+.SILENT:
+.DELETE_ON_ERROR:
+MAKEFLAGS+=--warn-undefined-variables
+MAKEFLAGS+=--no-builtin-rules
 
+# Colors
+# OK=Green, warn=yellow, error=red
+ifeq ($(TERM),)
+# no colors if not in terminal
+        MARK_COLOR=
+        OK_COLOR=
+        WARN_COLOR=
+        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`
+endif
+
+##############################################################################
+# SETTINGS AND VARIABLE
 DIR=$(shell basename $$(pwd))
-ADDON ?= "@eeacms/volto-slate-footnote"
-
-# We like colors
-# From: https://coderwall.com/p/izxssa/colored-makefile-for-golang-projects
-RED=`tput setaf 1`
-GREEN=`tput setaf 2`
-RESET=`tput sgr0`
-YELLOW=`tput setaf 3`
-
-project:
-	npm install -g yo
-	npm install -g @plone/generator-volto
-	npm install -g mrs-developer
-	yo @plone/volto project --addon ${ADDON} --workspace "src/addons/${DIR}" --no-interactive
-	ln -sf $$(pwd) project/src/addons/
-	cp .project.eslintrc.js .eslintrc.js
-	cd project && yarn
-	@echo "-------------------"
-	@echo "$(GREEN)Volto project is ready!$(RESET)"
-	@echo "$(RED)Now run: cd project && yarn start$(RESET)"
-
-all: project
-
-.PHONY: start-test-backend
-start-test-backend: ## Start Test Plone Backend
-	@echo "$(GREEN)==> Start Test Plone Backend$(RESET)"
-	docker run -i --rm -e ZSERVER_HOST=0.0.0.0 -e ZSERVER_PORT=55001 -p 55001:55001 -e SITE=plone -e APPLY_PROFILES=plone.app.contenttypes:plone-content,plone.restapi:default,kitconcept.volto:default-homepage -e CONFIGURE_PACKAGES=plone.app.contenttypes,plone.restapi,kitconcept.volto,kitconcept.volto.cors -e ADDONS='plone.app.robotframework plone.app.contenttypes plone.restapi kitconcept.volto' plone ./bin/robot-server plone.app.robotframework.testing.PLONE_ROBOT_TESTING
-
-.PHONY: start-backend-docker
-start-backend-docker:		## Starts a Docker-based backend
-	@echo "$(GREEN)==> Start Docker-based Plone Backend$(RESET)"
-	docker run -it --rm --name=plone -p 8080:8080 -e SITE=Plone -e ADDONS="kitconcept.volto" -e ZCML="kitconcept.volto.cors" plone
+NODE_MODULES?="../../../node_modules"
+PLONE_VERSION?=6
+VOLTO_VERSION?=16
+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
+
+# Top-level targets
+.PHONY: all
+all: clean install
+
+.PHONY: clean
+clean:			## Cleanup development environment
+	${DOCKER_COMPOSE} down --volumes --remove-orphans
+
+.PHONY: install
+install:		## Build and install development environment
+	echo "Running:	${DOCKER_COMPOSE} build"
+	${DOCKER_COMPOSE} pull
+	${DOCKER_COMPOSE} build
+
+.PHONY: start
+start:			## Start development environment
+	echo "Running:	${DOCKER_COMPOSE} up"
+	${DOCKER_COMPOSE} up
+
+.PHONY: shell
+shell:			## Start a shell in the frontend container
+	echo "Running:	${DOCKER_COMPOSE} run frontend bash"
+	${DOCKER_COMPOSE} run --entrypoint=bash frontend
+
+.PHONY: cypress-open
+cypress-open:		## Open cypress integration tests
+	NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress open
+
+.PHONY: cypress-run
+cypress-run:	## Run cypress integration tests
+	NODE_ENV=development  $(NODE_MODULES)/cypress/bin/cypress run
 
 .PHONY: test
-test:
-	docker pull plone/volto-addon-ci:alpha
-	docker run -it --rm -e NAMESPACE="@eeacms" -e GIT_NAME="${DIR}" -e RAZZLE_JEST_CONFIG=jest-addon.config.js -v "$$(pwd):/opt/frontend/my-volto-project/src/addons/${DIR}" -e CI="true" plone/volto-addon-ci:alpha
+test:			## Run jest tests
+	${DOCKER_COMPOSE} run -e CI=1 frontend test
 
 .PHONY: test-update
-test-update:
-	docker pull plone/volto-addon-ci:alpha
-	docker run -it --rm -e NAMESPACE="@eeacms" -e GIT_NAME="${DIR}" -e RAZZLE_JEST_CONFIG=jest-addon.config.js -v "$$(pwd):/opt/frontend/my-volto-project/src/addons/${DIR}" -e CI="true" plone/volto-addon-ci:alpha yarn test src/addons/${DIR}/src --watchAll=false -u
+test-update:	## Update jest tests snapshots
+	${DOCKER_COMPOSE} run -e CI=1 frontend test -u
+
+.PHONY: stylelint
+stylelint:		## Stylelint
+	$(NODE_MODULES)/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'
+
+.PHONY: stylelint-overrides
+stylelint-overrides:
+	$(NODE_MODULES)/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'
+
+.PHONY: stylelint-fix
+stylelint-fix:	## Fix stylelint
+	$(NODE_MODULES)/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}' --fix
+	$(NODE_MODULES)/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides' --fix
+
+.PHONY: prettier
+prettier:		## Prettier
+	$(NODE_MODULES)/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,json,css,less,md}'
+
+.PHONY: prettier-fix
+prettier-fix:	## Fix prettier
+	$(NODE_MODULES)/.bin/prettier --single-quote  --write 'src/**/*.{js,jsx,json,css,less,md}'
+
+.PHONY: lint
+lint:			## ES Lint
+	$(NODE_MODULES)/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx}'
+
+.PHONY: lint-fix
+lint-fix:		## Fix ES Lint
+	$(NODE_MODULES)/eslint/bin/eslint.js --fix 'src/**/*.{js,jsx}'
+
+.PHONY: i18n
+i18n:			## i18n
+	rm -rf build/messages
+	NODE_ENV=development $(NODE_MODULES)/.bin/i18n --addon
 
 .PHONY: help
-help:		## Show this help.
+help:                   ## Show this help.
 	@echo -e "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\\x1b[36m\1\\x1b[m:\2/' | column -c2 -t -s :)"
+	head -n 14 Makefile

package/README.md

@@ -31,9 +31,26 @@ This version requires: `@plone/volto >= 16.0.0.alpha.15` (`volto-slate` part of
 
 ## Getting started
 
+### Try volto-slate-footnote with Docker
+
+      git clone https://github.com/eea/volto-slate-footnote.git
+      cd volto-slate-footnote
+      make
+      make start
+
+Go to http://localhost:3000
+
 ### Add volto-slate-footnote to your Volto project
 
-1. If you already have a volto project, just update `package.json`:
+1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
+
+    ```Bash
+    docker compose up backend
+    ```
+
+1. Start Volto frontend
+
+- If you already have a volto project, just update `package.json`:
 
    ```JSON
    "addons": [

package/cypress/e2e/01-slate-footnote-block.cy.js

@@ -41,6 +41,7 @@ describe('Slate citations', () => {
     cy.get('span.citation-item').contains('Colorless green');
     cy.contains('Footnotes');
     cy.contains('Citation');
+    cy.get('[aria-label="Back to content"]').first().click();
   });
 
   it('Add Footnotes block and create multiple citations', () => {

package/docker-compose.yml

@@ -0,0 +1,32 @@
+version: "3"
+services:
+  backend:
+    image: eeacms/plone-backend
+    ports:
+      - "8080:8080"
+    environment:
+      SITE: "Plone"
+      PROFILES: "eea.kitkat:testing"
+
+  frontend: 
+    build:
+      context: ./
+      dockerfile: ./Dockerfile
+      args:
+        ADDON_NAME: "${ADDON_NAME}"
+        ADDON_PATH: "${ADDON_PATH}"
+        VOLTO_VERSION: ${VOLTO_VERSION:-16}
+    ports:
+    - "3000:3000"
+    - "3001:3001"
+    depends_on:
+      - backend
+    volumes:
+      - ./:/app/src/addons/${ADDON_PATH}
+    environment:
+      CI: "true"
+      NODE_ENV: "development"
+      RAZZLE_JEST_CONFIG: "src/addons/${ADDON_PATH}/jest-addon.config.js"
+      RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone"
+      RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone"
+      HOST: "0.0.0.0"

package/locales/de/LC_MESSAGES/volto.po

@@ -0,0 +1,32 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#: editor/index
+# defaultMessage: Edit footnote
+msgid "Edit footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: No options
+msgid "No options"
+msgstr ""
+
+#: editor/index
+# defaultMessage: Remove footnote
+msgid "Remove footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: Select…
+msgid "Select…"
+msgstr ""

package/locales/en/LC_MESSAGES/volto.po

@@ -0,0 +1,32 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#: editor/index
+# defaultMessage: Edit footnote
+msgid "Edit footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: No options
+msgid "No options"
+msgstr ""
+
+#: editor/index
+# defaultMessage: Remove footnote
+msgid "Remove footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: Select…
+msgid "Select…"
+msgstr ""

package/locales/it/LC_MESSAGES/volto.po

@@ -0,0 +1,32 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#: editor/index
+# defaultMessage: Edit footnote
+msgid "Edit footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: No options
+msgid "No options"
+msgstr ""
+
+#: editor/index
+# defaultMessage: Remove footnote
+msgid "Remove footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: Select…
+msgid "Select…"
+msgstr ""

package/locales/ro/LC_MESSAGES/volto.po

@@ -0,0 +1,32 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#: editor/index
+# defaultMessage: Edit footnote
+msgid "Edit footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: No options
+msgid "No options"
+msgstr ""
+
+#: editor/index
+# defaultMessage: Remove footnote
+msgid "Remove footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: Select…
+msgid "Select…"
+msgstr ""

package/locales/volto.pot

@@ -0,0 +1,34 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: Plone\n"
+"POT-Creation-Date: 2023-08-29T17:14:46.877Z\n"
+"Last-Translator: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
+"Language-Team: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Language-Code: en\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8\n"
+"Domain: volto\n"
+
+#: editor/index
+# defaultMessage: Edit footnote
+msgid "Edit footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: No options
+msgid "No options"
+msgstr ""
+
+#: editor/index
+# defaultMessage: Remove footnote
+msgid "Remove footnote"
+msgstr ""
+
+#: editor/MultiSelectSearchWidget
+# defaultMessage: Select…
+msgid "Select…"
+msgstr ""

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-slate-footnote",
-  "version": "6.1.2",
+  "version": "6.1.3",
   "description": "volto-slate-footnote: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -27,19 +27,21 @@
   },
   "scripts": {
     "release": "release-it",
+    "release-major-beta": "release-it major --preRelease=beta",
+    "release-beta": "release-it --preRelease=beta",
     "bootstrap": "npm install -g ejs; npm link ejs; node bootstrap",
     "test": "make test",
     "test:fix": "make test-update",
     "pre-commit": "yarn stylelint:fix && yarn prettier:fix && yarn lint:fix",
-    "stylelint": "../../../node_modules/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'",
-    "stylelint:overrides": "../../../node_modules/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'",
-    "stylelint:fix": "yarn stylelint --fix && yarn stylelint:overrides --fix",
-    "prettier": "../../../node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,json,css,less,md}'",
-    "prettier:fix": "../../../node_modules/.bin/prettier --single-quote --write 'src/**/*.{js,jsx,json,css,less,md}'",
-    "lint": "../../../node_modules/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx}'",
-    "lint:fix": "../../../node_modules/eslint/bin/eslint.js --fix 'src/**/*.{js,jsx}'",
-    "i18n": "rm -rf build/messages && NODE_ENV=production i18n --addon",
-    "cypress:run": "NODE_ENV=development ../../../node_modules/cypress/bin/cypress run",
-    "cypress:open": "NODE_ENV=development ../../../node_modules/cypress/bin/cypress open"
+    "stylelint": "make stylelint",
+    "stylelint:overrides": "make stylelint-overrides",
+    "stylelint:fix": "make stylelint-fix",
+    "prettier": "make prettier",
+    "prettier:fix": "make prettier-fix",
+    "lint": "make lint",
+    "lint:fix": "make lint-fix",
+    "i18n": "make i18n",
+    "cypress:run": "make cypress-run",
+    "cypress:open": "make cypress-open"
   }
 }

package/src/editor/utils.js

@@ -31,8 +31,7 @@ export const openAccordionIfContainsFootnoteReference = (footnoteId) => {
 
 const blockTypesOperations = {
   metadataSection: (block, properties) => {
-    const fields = block.fields;
-
+    const fields = block?.fields || [];
     return fields
       .filter((field) => field?.field?.widget === 'slate')
       .reduce((accumulator, currentField) => {
@@ -48,8 +47,7 @@ const blockTypesOperations = {
       }, []);
   },
   metadata: (block, properties) => {
-    const fId = block.data.id;
-
+    const fId = block?.data?.id;
     return block?.data?.widget === 'slate'
       ? [
           {