@eeacms/volto-flourish 0.1.6 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/CHANGELOG.md +13 -1
  2. package/DEVELOP.md +19 -17
  3. package/README.md +33 -19
  4. package/docker-compose.yml +1 -1
  5. package/jest-addon.config.js +11 -4
  6. package/locales/volto.pot +2 -2
  7. package/package.json +1 -1
  8. package/src/blocks/EmbedFlourish/Edit.test.jsx +1 -1
  9. package/src/blocks/EmbedFlourish/View.test.jsx +1 -1
package/CHANGELOG.md CHANGED
@@ -4,7 +4,19 @@ All notable changes to this project will be documented in this file. Dates are d
4
4
 
5
5
  Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
6
6
 
7
- ### [0.1.6](https://github.com/eea/volto-flourish/compare/0.1.5...0.1.6) - 24 February 2025
7
+ ### [1.0.0](https://github.com/eea/volto-flourish/compare/0.1.6...1.0.0) - 25 March 2026
8
+
9
+ #### :rocket: New Features
10
+
11
+ - feat: Volto 18 support - refs #287700 [Alin Voinea - [`4f58ae4`](https://github.com/eea/volto-flourish/commit/4f58ae4abd83bd40467656d93ec24b65b3d06ecc)]
12
+
13
+ #### :house: Internal changes
14
+
15
+
16
+ #### :hammer_and_wrench: Others
17
+
18
+ - tests: Fix Sonar Qube tags - refs #297339 [Alin Voinea - [`a2dded8`](https://github.com/eea/volto-flourish/commit/a2dded891d50efc1b1315bb2a6d341c6d2f80047)]
19
+ ### [0.1.6](https://github.com/eea/volto-flourish/compare/0.1.5...0.1.6) - 28 February 2025
8
20
 
9
21
  #### :hammer_and_wrench: Others
10
22
 
package/DEVELOP.md CHANGED
@@ -26,21 +26,20 @@
26
26
 
27
27
  ### Or add @eeacms/volto-flourish to your Volto project
28
28
 
29
- Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
29
+ 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).
30
30
 
31
- 1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
31
+ For new Volto 18+ projects, use Cookieplone. It includes `mrs-developer` by default.
32
32
 
33
- npm install -g yo @plone/generator-volto mrs-developer
33
+ 1. Create a new Volto project with Cookieplone
34
34
 
35
- 1. Create new volto app
36
-
37
- yo @plone/volto my-volto-project --addon @eeacms/volto-flourish --skip-install
38
- cd my-volto-project
35
+ uvx cookieplone project
36
+ cd project-title
39
37
 
40
38
  1. Add the following to `mrs.developer.json`:
41
39
 
42
40
  {
43
41
  "volto-flourish": {
42
+ "output": "packages",
44
43
  "url": "https://github.com/eea/volto-flourish.git",
45
44
  "package": "@eeacms/volto-flourish",
46
45
  "branch": "develop",
@@ -48,28 +47,31 @@ Before starting make sure your development environment is properly set. See [Vol
48
47
  }
49
48
  }
50
49
 
51
- 1. Install
50
+ 1. Add `@eeacms/volto-flourish` to the `addons` key in your project `volto.config.js`
51
+
52
+ 1. Install or refresh the project setup
52
53
 
53
- make develop
54
- yarn
54
+ make install
55
55
 
56
- 1. Start backend
56
+ 1. Start backend in one terminal
57
57
 
58
- docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
58
+ make backend-start
59
59
 
60
- ...wait for backend to setup and start - `Ready to handle requests`:
60
+ ...wait for backend to setup and start, ending with `Ready to handle requests`
61
61
 
62
62
  ...you can also check http://localhost:8080/Plone
63
63
 
64
- 1. Start frontend
64
+ 1. Start frontend in a second terminal
65
65
 
66
- yarn start
66
+ make frontend-start
67
67
 
68
68
  1. Go to http://localhost:3000
69
69
 
70
70
  1. Happy hacking!
71
71
 
72
- cd src/addons/volto-flourish/
72
+ cd packages/volto-flourish
73
+
74
+ For legacy Volto 17 projects, keep using the yarn-based workflow from the Volto 17 documentation.
73
75
 
74
76
  ## Cypress
75
77
 
@@ -81,7 +83,7 @@ project where you added `volto-flourish` to `mrs.developer.json`
81
83
  Go to:
82
84
 
83
85
  ```BASH
84
- cd src/addons/volto-flourish/
86
+ cd packages/volto-flourish/
85
87
  ```
86
88
 
87
89
  Start:
package/README.md CHANGED
@@ -3,16 +3,16 @@
3
3
  [![Releases](https://img.shields.io/github/v/release/eea/volto-flourish)](https://github.com/eea/volto-flourish/releases)
4
4
 
5
5
  [![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-flourish%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-flourish/job/master/display/redirect)
6
- [![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-master)
7
- [![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-master)
8
- [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-master)
9
- [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-master)
6
+ [![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish)
7
+ [![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish)
8
+ [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish)
9
+ [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish)
10
10
 
11
11
  [![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-flourish%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-flourish/job/develop/display/redirect)
12
- [![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-develop)
13
- [![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-develop)
14
- [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-develop)
15
- [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish-develop)
12
+ [![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&branch=develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish&branch=develop)
13
+ [![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&branch=develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish&branch=develop)
14
+ [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&branch=develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish&branch=develop)
15
+ [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-flourish&branch=develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-flourish&branch=develop)
16
16
 
17
17
  [Volto](https://github.com/plone/volto) add-on
18
18
 
@@ -34,6 +34,11 @@ Flourish integration
34
34
 
35
35
  Go to http://localhost:3000
36
36
 
37
+ `make start` now defaults to Volto 18. To run the same setup against Volto 17, use:
38
+
39
+ VOLTO_VERSION=17 make
40
+ VOLTO_VERSION=17 make start
41
+
37
42
  ### Add volto-flourish to your Volto project
38
43
 
39
44
  1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
@@ -47,30 +52,39 @@ Go to http://localhost:3000
47
52
  - If you already have a volto project, just update `package.json`:
48
53
 
49
54
  ```JSON
50
- "addons": [
51
- "@eeacms/volto-flourish"
52
- ],
53
-
54
55
  "dependencies": {
55
56
  "@eeacms/volto-flourish": "*"
56
57
  }
57
58
  ```
58
59
 
59
- - If not, create one:
60
+ and `volto.config.js`:
61
+
62
+ ```JavaScript
63
+ const addons = ['@eeacms/volto-flourish'];
64
+ ```
65
+
66
+ - If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:
60
67
 
61
68
  ```
62
- npm install -g yo @plone/generator-volto
63
- yo @plone/volto my-volto-project --canary --addon @eeacms/volto-flourish
64
- cd my-volto-project
69
+ uvx cookieplone project
70
+ cd project-title
65
71
  ```
66
72
 
67
- 1. Install new add-ons and restart Volto:
73
+ 1. Install or update dependencies, then start the project:
68
74
 
69
75
  ```
70
- yarn
71
- yarn start
76
+ make install
72
77
  ```
73
78
 
79
+ For a Cookieplone project, start the backend and frontend in separate terminals:
80
+
81
+ ```
82
+ make backend-start
83
+ make frontend-start
84
+ ```
85
+
86
+ For a legacy Volto 17 project, install the package with `yarn` and restart the frontend as usual.
87
+
74
88
  1. Go to http://localhost:3000
75
89
 
76
90
  1. Happy editing!
package/docker-compose.yml CHANGED
@@ -15,7 +15,7 @@ services:
15
15
  args:
16
16
  ADDON_NAME: "${ADDON_NAME}"
17
17
  ADDON_PATH: "${ADDON_PATH}"
18
- VOLTO_VERSION: ${VOLTO_VERSION:-16}
18
+ VOLTO_VERSION: ${VOLTO_VERSION:-18-yarn}
19
19
  ports:
20
20
  - "3000:3000"
21
21
  - "3001:3001"
package/jest-addon.config.js CHANGED
@@ -1,5 +1,14 @@
1
1
  require('dotenv').config({ path: __dirname + '/.env' })
2
2
 
3
+ const fs = require('fs')
4
+ const path = require('path')
5
+
6
+ const voltoSlatePath = fs.existsSync(
7
+ path.join(__dirname, '../../../node_modules/@plone/volto-slate/src'),
8
+ )
9
+ ? '<rootDir>/node_modules/@plone/volto-slate/src'
10
+ : '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src'
11
+
3
12
  module.exports = {
4
13
  testMatch: ['**/src/addons/**/?(*.)+(spec|test).[jt]s?(x)'],
5
14
  collectCoverageFrom: [
@@ -17,10 +26,8 @@ module.exports = {
17
26
  '@eeacms/search/(.*)$': '<rootDir>/src/addons/volto-searchlib/searchlib/$1',
18
27
  '@eeacms/search': '<rootDir>/src/addons/volto-searchlib/searchlib',
19
28
  '@eeacms/(.*?)/(.*)$': '<rootDir>/node_modules/@eeacms/$1/src/$2',
20
- '@plone/volto-slate$':
21
- '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src',
22
- '@plone/volto-slate/(.*)$':
23
- '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src/$1',
29
+ '@plone/volto-slate$': voltoSlatePath,
30
+ '@plone/volto-slate/(.*)$': `${voltoSlatePath}/$1`,
24
31
  '~/(.*)$': '<rootDir>/src/$1',
25
32
  'load-volto-addons':
26
33
  '<rootDir>/node_modules/@plone/volto/jest-addons-loader.js',
package/locales/volto.pot CHANGED
@@ -1,13 +1,13 @@
1
1
  msgid ""
2
2
  msgstr ""
3
3
  "Project-Id-Version: Plone\n"
4
- "POT-Creation-Date: 2023-06-28T10:48:22.678Z\n"
4
+ "POT-Creation-Date: 2026-03-10T22:13:04.847Z\n"
5
5
  "Last-Translator: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
6
6
  "Language-Team: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
7
- "MIME-Version: 1.0\n"
8
7
  "Content-Type: text/plain; charset=utf-8\n"
9
8
  "Content-Transfer-Encoding: 8bit\n"
10
9
  "Plural-Forms: nplurals=1; plural=0;\n"
10
+ "MIME-Version: 1.0\n"
11
11
  "Language-Code: en\n"
12
12
  "Language-Name: English\n"
13
13
  "Preferred-Encodings: utf-8\n"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eeacms/volto-flourish",
3
- "version": "0.1.6",
3
+ "version": "1.0.0",
4
4
  "description": "@eeacms/volto-flourish: Volto add-on",
5
5
  "main": "src/index.js",
6
6
  "author": "European Environment Agency: IDM2 A-Team",
package/src/blocks/EmbedFlourish/Edit.test.jsx CHANGED
@@ -2,7 +2,7 @@ import React from 'react';
2
2
  import { MemoryRouter } from 'react-router-dom';
3
3
  import configureStore from 'redux-mock-store';
4
4
  import { render } from '@testing-library/react';
5
- import '@testing-library/jest-dom/extend-expect';
5
+ import '@testing-library/jest-dom';
6
6
  import { Provider } from 'react-intl-redux';
7
7
  import Edit from './Edit';
8
8
 
package/src/blocks/EmbedFlourish/View.test.jsx CHANGED
@@ -2,7 +2,7 @@ import React from 'react';
2
2
  import { MemoryRouter } from 'react-router-dom';
3
3
  import configureStore from 'redux-mock-store';
4
4
  import { render } from '@testing-library/react';
5
- import '@testing-library/jest-dom/extend-expect';
5
+ import '@testing-library/jest-dom';
6
6
  import { Provider } from 'react-intl-redux';
7
7
  import View from './View';
8
8