@eeacms/volto-widget-toggle 5.0.0 → 6.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.
- package/CHANGELOG.md +18 -14
- package/README.md +23 -37
- package/babel.config.js +1 -17
- package/package.json +34 -18
- package/src/components/manage/Widgets/CheckboxWidget.jsx +1 -1
- package/src/components/manage/Widgets/CheckboxWidget.test.jsx +4 -3
- package/tsconfig.json +43 -0
- package/vitest.config.mjs +283 -0
- package/vitest.setup.jsx +64 -0
- package/.coverage.babel.config.js +0 -9
- package/.eslintrc.js +0 -65
- package/.husky/pre-commit +0 -2
- package/DEVELOP.md +0 -108
- package/RELEASE.md +0 -74
- package/bootstrap +0 -41
- package/cypress.config.js +0 -26
- package/docker-compose.yml +0 -32
- package/jest-addon.config.js +0 -58
- package/jest.setup.js +0 -65
package/CHANGELOG.md
CHANGED
|
@@ -4,14 +4,29 @@ 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
|
-
### [
|
|
7
|
+
### [6.0.0](https://github.com/eea/volto-widget-toggle/compare/5.0.1...6.0.0) - 19 November 2026
|
|
8
8
|
|
|
9
9
|
#### :rocket: New Features
|
|
10
10
|
|
|
11
|
-
- feat: Volto
|
|
11
|
+
- feat: Volto 19 support - refs #297832 [Alin Voinea - [`4b85446`](https://github.com/eea/volto-widget-toggle/commit/4b85446e70d5622b7473b8214623821ccab5ccc9)]
|
|
12
12
|
|
|
13
|
-
#### :
|
|
13
|
+
#### :bug: Bug Fixes
|
|
14
|
+
|
|
15
|
+
- fix: Add betterleaks github action - refs #304517 [dobri1408 - [`a80dae3`](https://github.com/eea/volto-widget-toggle/commit/a80dae3f6766bb0f85660b19883ffd01416c350b)]
|
|
16
|
+
|
|
17
|
+
#### :hammer_and_wrench: Others
|
|
18
|
+
|
|
19
|
+
- test: pin Chromium version 149 to work with Cypress [valentinab25 - [`c346bd2`](https://github.com/eea/volto-widget-toggle/commit/c346bd2739ac9a20f86c70a314988b9cab5b53a0)]
|
|
20
|
+
### [5.0.1](https://github.com/eea/volto-widget-toggle/compare/5.0.0...5.0.1) - 9 April 2026
|
|
21
|
+
|
|
22
|
+
#### :hammer_and_wrench: Others
|
|
23
|
+
|
|
24
|
+
- test: Fix make test [Alin V. (Claudiu) - [`8cf30a1`](https://github.com/eea/volto-widget-toggle/commit/8cf30a17057899a44781075fdf7ed962d9607920)]
|
|
25
|
+
## [5.0.0](https://github.com/eea/volto-widget-toggle/compare/4.0.0...5.0.0) - 25 March 2026
|
|
26
|
+
|
|
27
|
+
#### :rocket: New Features
|
|
14
28
|
|
|
29
|
+
- feat: Volto 18 support - refs #287700 [Alin Voinea - [`e8d9163`](https://github.com/eea/volto-widget-toggle/commit/e8d9163a2df3e87871914b77b9c04730d686e970)]
|
|
15
30
|
|
|
16
31
|
#### :hammer_and_wrench: Others
|
|
17
32
|
|
|
@@ -27,8 +42,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
|
|
|
27
42
|
|
|
28
43
|
- chore: husky, lint-staged use fixed versions [valentinab25 - [`78c47fe`](https://github.com/eea/volto-widget-toggle/commit/78c47fea7a704d1addd796ac5f515d262379da92)]
|
|
29
44
|
|
|
30
|
-
#### :hammer_and_wrench: Others
|
|
31
|
-
|
|
32
45
|
### [3.1.4](https://github.com/eea/volto-widget-toggle/compare/3.1.3...3.1.4) - 16 October 2023
|
|
33
46
|
|
|
34
47
|
#### :house: Internal changes
|
|
@@ -54,7 +67,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
|
|
|
54
67
|
- test: EN locales, pre-commit fix, feature PRs checks Refs #257193 [valentinab25 - [`b2f509e`](https://github.com/eea/volto-widget-toggle/commit/b2f509eb236e0beeccfc8bc89f4c6527a3fca223)]
|
|
55
68
|
- test: Fix package.json scripts to use makefile [Alin Voinea - [`72e8245`](https://github.com/eea/volto-widget-toggle/commit/72e8245a4741988849eaa73e5fd238ff6d340fa9)]
|
|
56
69
|
- i18n: Add en [Alin Voinea - [`e60d799`](https://github.com/eea/volto-widget-toggle/commit/e60d799a64230544e37e1f4796dc73bbc0e674c6)]
|
|
57
|
-
- test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`f86b2f7`](https://github.com/eea/volto-widget-toggle/commit/f86b2f7119f24b637e8bc8101effc2c2c3416a65)]
|
|
58
70
|
### [3.1.2](https://github.com/eea/volto-widget-toggle/compare/3.1.1...3.1.2) - 24 July 2023
|
|
59
71
|
|
|
60
72
|
### [3.1.1](https://github.com/eea/volto-widget-toggle/compare/3.1.0...3.1.1) - 12 June 2023
|
|
@@ -65,9 +77,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
|
|
|
65
77
|
- test: Fix test config, coverage Refs #253277 [valentinab25 - [`b4f3492`](https://github.com/eea/volto-widget-toggle/commit/b4f3492448826968dfbb979fad00f0b65d644017)]
|
|
66
78
|
### [3.1.0](https://github.com/eea/volto-widget-toggle/compare/3.0.1...3.1.0) - 27 March 2023
|
|
67
79
|
|
|
68
|
-
#### :hammer_and_wrench: Others
|
|
69
|
-
|
|
70
|
-
- test(Jenkins): Run tests and cypress with latest canary @plone/volto [Alin Voinea - [`c658d9f`](https://github.com/eea/volto-widget-toggle/commit/c658d9f0fc0fc6cc4b26041b79c93c0982b152c5)]
|
|
71
80
|
### [3.0.1](https://github.com/eea/volto-widget-toggle/compare/3.0.0...3.0.1) - 16 November 2022
|
|
72
81
|
|
|
73
82
|
#### :hammer_and_wrench: Others
|
|
@@ -83,12 +92,8 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
|
|
|
83
92
|
- update(jest): add @plone/volto-slate resolver refs- #153447 [nileshgulia1 - [`b5e6889`](https://github.com/eea/volto-widget-toggle/commit/b5e6889bc22efaeec2025bd79dfe2a839650e4a6)]
|
|
84
93
|
### [2.2.7](https://github.com/eea/volto-widget-toggle/compare/2.2.6...2.2.7) - 30 June 2022
|
|
85
94
|
|
|
86
|
-
#### :hammer_and_wrench: Others
|
|
87
|
-
|
|
88
95
|
### [2.2.6](https://github.com/eea/volto-widget-toggle/compare/2.2.5...2.2.6) - 3 January 2022
|
|
89
96
|
|
|
90
|
-
#### :hammer_and_wrench: Others
|
|
91
|
-
|
|
92
97
|
### [2.2.5](https://github.com/eea/volto-widget-toggle/compare/2.2.4...2.2.5) - 16 December 2021
|
|
93
98
|
|
|
94
99
|
### [2.2.4](https://github.com/eea/volto-widget-toggle/compare/2.2.3...2.2.4) - 10 December 2021
|
|
@@ -116,7 +121,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
|
|
|
116
121
|
#### :hammer_and_wrench: Others
|
|
117
122
|
|
|
118
123
|
- Release 2.1.0 [Alin Voinea - [`8a77751`](https://github.com/eea/volto-widget-toggle/commit/8a77751a8eaa3817f4831a21365768387321dc50)]
|
|
119
|
-
- Cleanup DEPENDENCIES from Jenkinsfile [Alin Voinea - [`41eb8ba`](https://github.com/eea/volto-widget-toggle/commit/41eb8ba076da6feed4bfc8f05ed1c18678b4a434)]
|
|
120
124
|
## [2.0.0](https://github.com/eea/volto-widget-toggle/compare/1.0.1...2.0.0) - 26 February 2021
|
|
121
125
|
|
|
122
126
|
#### :hammer_and_wrench: Others
|
package/README.md
CHANGED
|
@@ -1,18 +1,8 @@
|
|
|
1
|
-
# volto-widget-toggle
|
|
1
|
+
# @eeacms/volto-widget-toggle
|
|
2
2
|
|
|
3
3
|
[](https://github.com/eea/volto-widget-toggle/releases)
|
|
4
|
-
|
|
5
4
|
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-toggle/job/master/display/redirect)
|
|
6
|
-
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle)
|
|
7
5
|
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle)
|
|
8
|
-
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle)
|
|
9
|
-
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle)
|
|
10
|
-
|
|
11
|
-
[](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-widget-toggle/job/develop/display/redirect)
|
|
12
|
-
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle&branch=develop)
|
|
13
|
-
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle&branch=develop)
|
|
14
|
-
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle&branch=develop)
|
|
15
|
-
[](https://sonarqube.eea.europa.eu/dashboard?id=volto-widget-toggle&branch=develop)
|
|
16
6
|
|
|
17
7
|
[Volto](https://github.com/plone/volto) add-on: Replace any checkbox with a nice toggle button within edit forms
|
|
18
8
|
|
|
@@ -20,23 +10,32 @@
|
|
|
20
10
|
|
|
21
11
|

|
|
22
12
|
|
|
23
|
-
##
|
|
13
|
+
## Upgrade
|
|
14
|
+
|
|
15
|
+
### Upgrading to 6.x
|
|
16
|
+
|
|
17
|
+
> This version requires `Volto 18` or `Volto 19` and Node.js 22.
|
|
18
|
+
|
|
19
|
+
The widget keeps the same id and the same behaviour, so upgrading from 5.x on Volto 18 needs no content changes. The release adds Volto 19 support and moves the repository to the Volto 19 layout, where the published package lives in `packages/volto-widget-toggle`.
|
|
20
|
+
|
|
21
|
+
#### Breaking changes
|
|
22
|
+
|
|
23
|
+
- **Node.js 22 or newer is required** (`engines.node >= 22`), 5.x declared no engine.
|
|
24
|
+
- **React 18 is required.** The package declares `react` and `react-dom` as `^18.2.0` peers, 5.x declared no peers.
|
|
25
|
+
- **The package no longer ships the Jest setup.** `jest-addon.config.js` and `jest.setup.js` were removed in favour of Vitest, so a Volto 18 project that still runs the Jest harness has to keep its own copy.
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
## Requirements
|
|
26
28
|
|
|
27
|
-
|
|
28
|
-
cd volto-widget-toggle
|
|
29
|
-
make
|
|
30
|
-
make start
|
|
29
|
+
### Backend
|
|
31
30
|
|
|
32
|
-
|
|
31
|
+
- [Plone](https://plone.org/download)
|
|
32
|
+
- [plone.restapi](https://pypi.org/project/plone.restapi/)
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
### Frontend
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
VOLTO_VERSION=17 make start
|
|
36
|
+
- Node.js: `>=22.0.0`
|
|
38
37
|
|
|
39
|
-
|
|
38
|
+
## Installation
|
|
40
39
|
|
|
41
40
|
1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
|
|
42
41
|
|
|
@@ -80,26 +79,13 @@ Go to http://localhost:3000
|
|
|
80
79
|
make frontend-start
|
|
81
80
|
```
|
|
82
81
|
|
|
83
|
-
For a legacy Volto 17 project, install the package with `yarn` and restart the frontend as usual.
|
|
84
|
-
|
|
85
82
|
1. Go to http://localhost:3000
|
|
86
83
|
|
|
87
84
|
1. Happy editing!
|
|
88
85
|
|
|
89
|
-
##
|
|
90
|
-
|
|
91
|
-
See [RELEASE.md](https://github.com/eea/volto-widget-toggle/blob/master/RELEASE.md).
|
|
92
|
-
|
|
93
|
-
## How to contribute
|
|
94
|
-
|
|
95
|
-
See [DEVELOP.md](https://github.com/eea/volto-widget-toggle/blob/master/DEVELOP.md).
|
|
96
|
-
|
|
97
|
-
## Copyright and license
|
|
98
|
-
|
|
99
|
-
The Initial Owner of the Original Code is European Environment Agency (EEA).
|
|
100
|
-
All Rights Reserved.
|
|
86
|
+
## License
|
|
101
87
|
|
|
102
|
-
See [LICENSE.md](
|
|
88
|
+
See [LICENSE.md](LICENSE.md) for details.
|
|
103
89
|
|
|
104
90
|
## Funding
|
|
105
91
|
|
package/babel.config.js
CHANGED
|
@@ -1,17 +1 @@
|
|
|
1
|
-
module.exports =
|
|
2
|
-
api.cache(true);
|
|
3
|
-
const presets = ['razzle'];
|
|
4
|
-
const plugins = [
|
|
5
|
-
[
|
|
6
|
-
'react-intl', // React Intl extractor, required for the whole i18n infrastructure to work
|
|
7
|
-
{
|
|
8
|
-
messagesDir: './build/messages/',
|
|
9
|
-
},
|
|
10
|
-
],
|
|
11
|
-
];
|
|
12
|
-
|
|
13
|
-
return {
|
|
14
|
-
plugins,
|
|
15
|
-
presets,
|
|
16
|
-
};
|
|
17
|
-
};
|
|
1
|
+
module.exports = require('@plone/volto/babel');
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eeacms/volto-widget-toggle",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "6.0.0",
|
|
4
4
|
"description": "volto-widget-toggle: Volto add-on to replace checkboxes with toggle buttons",
|
|
5
5
|
"main": "src/index.js",
|
|
6
6
|
"author": "European Environment Agency: IDM2 A-Team",
|
|
@@ -20,12 +20,25 @@
|
|
|
20
20
|
},
|
|
21
21
|
"devDependencies": {
|
|
22
22
|
"@cypress/code-coverage": "^3.10.0",
|
|
23
|
-
"@plone/scripts": "*",
|
|
24
23
|
"babel-plugin-transform-class-properties": "^6.24.1",
|
|
25
24
|
"dotenv": "^16.3.2",
|
|
26
25
|
"husky": "^8.0.3",
|
|
27
26
|
"lint-staged": "^14.0.1",
|
|
28
|
-
"md5": "^2.3.0"
|
|
27
|
+
"md5": "^2.3.0",
|
|
28
|
+
"@testing-library/jest-dom": "6.9.1",
|
|
29
|
+
"@testing-library/react": "^16.3.2",
|
|
30
|
+
"@types/react": "^18.3.1",
|
|
31
|
+
"@types/react-dom": "^18.3.1",
|
|
32
|
+
"@vitejs/plugin-react": "4.7.0",
|
|
33
|
+
"@vitest/coverage-istanbul": "3.2.7",
|
|
34
|
+
"cypress": "13.1.0",
|
|
35
|
+
"jsdom": "23.0.0",
|
|
36
|
+
"redux-mock-store": "1.5.4",
|
|
37
|
+
"redux-thunk": "^2.4.2",
|
|
38
|
+
"release-it": "^19.0.5",
|
|
39
|
+
"typescript": "^5.7.3",
|
|
40
|
+
"vite": "6.4.3",
|
|
41
|
+
"vitest": "3.2.7"
|
|
29
42
|
},
|
|
30
43
|
"lint-staged": {
|
|
31
44
|
"src/**/*.{js,jsx,ts,tsx,json}": [
|
|
@@ -52,20 +65,23 @@
|
|
|
52
65
|
"release": "release-it",
|
|
53
66
|
"release-major-beta": "release-it major --preRelease=beta",
|
|
54
67
|
"release-beta": "release-it --preRelease=beta",
|
|
55
|
-
"
|
|
56
|
-
"test": "
|
|
57
|
-
"
|
|
58
|
-
"
|
|
59
|
-
"
|
|
60
|
-
"
|
|
61
|
-
"
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
"
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
"
|
|
69
|
-
|
|
68
|
+
"test": "vitest --config ./vitest.config.mjs run --passWithNoTests",
|
|
69
|
+
"test:fix": "vitest --config ./vitest.config.mjs run --passWithNoTests --update",
|
|
70
|
+
"i18n": "rm -rf build/messages && NODE_ENV=production i18n --addon",
|
|
71
|
+
"prepare": "cd ../.. && husky install || true",
|
|
72
|
+
"dry-release": "release-it --dry-run",
|
|
73
|
+
"release-major-alpha": "release-it major --preRelease=alpha",
|
|
74
|
+
"release-alpha": "release-it --preRelease=alpha"
|
|
75
|
+
},
|
|
76
|
+
"packageManager": "pnpm@10.20.0",
|
|
77
|
+
"engines": {
|
|
78
|
+
"node": ">=22.0.0"
|
|
79
|
+
},
|
|
80
|
+
"publishConfig": {
|
|
81
|
+
"access": "public"
|
|
82
|
+
},
|
|
83
|
+
"peerDependencies": {
|
|
84
|
+
"react": "^18.2.0",
|
|
85
|
+
"react-dom": "^18.2.0"
|
|
70
86
|
}
|
|
71
87
|
}
|
|
@@ -8,7 +8,7 @@ import PropTypes from 'prop-types';
|
|
|
8
8
|
import { Checkbox } from 'semantic-ui-react';
|
|
9
9
|
|
|
10
10
|
import { injectIntl } from 'react-intl';
|
|
11
|
-
import
|
|
11
|
+
import FormFieldWrapper from '@plone/volto/components/manage/Widgets/FormFieldWrapper';
|
|
12
12
|
|
|
13
13
|
/**
|
|
14
14
|
* CheckboxWidget component class.
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { vi } from 'vitest';
|
|
1
2
|
import React from 'react';
|
|
2
3
|
import { render, waitFor } from '@testing-library/react';
|
|
3
4
|
import { Provider } from 'react-intl-redux';
|
|
@@ -10,15 +11,15 @@ const store = mockStore({
|
|
|
10
11
|
intl: {
|
|
11
12
|
locale: 'en',
|
|
12
13
|
messages: {},
|
|
13
|
-
formatMessage:
|
|
14
|
+
formatMessage: vi.fn(),
|
|
14
15
|
},
|
|
15
16
|
});
|
|
16
17
|
|
|
17
|
-
const mockOnChange =
|
|
18
|
+
const mockOnChange = vi.fn();
|
|
18
19
|
|
|
19
20
|
describe('CheckboxWidget', () => {
|
|
20
21
|
beforeEach(() => {
|
|
21
|
-
|
|
22
|
+
vi.clearAllMocks();
|
|
22
23
|
});
|
|
23
24
|
|
|
24
25
|
it('renders a checkbox', async () => {
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"esModuleInterop": true,
|
|
4
|
+
"skipLibCheck": true,
|
|
5
|
+
"target": "es2022",
|
|
6
|
+
"allowJs": true,
|
|
7
|
+
"resolveJsonModule": true,
|
|
8
|
+
"moduleDetection": "force",
|
|
9
|
+
"isolatedModules": true,
|
|
10
|
+
"verbatimModuleSyntax": true,
|
|
11
|
+
"module": "preserve",
|
|
12
|
+
"noEmit": true,
|
|
13
|
+
"lib": [
|
|
14
|
+
"es2022",
|
|
15
|
+
"dom",
|
|
16
|
+
"dom.iterable"
|
|
17
|
+
],
|
|
18
|
+
"jsx": "react-jsx",
|
|
19
|
+
"paths": {
|
|
20
|
+
"@plone/volto/*": [
|
|
21
|
+
"../../core/packages/volto/src/*"
|
|
22
|
+
],
|
|
23
|
+
"@eeacms/volto-widget-toggle/*": [
|
|
24
|
+
"./src/*"
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"include": [
|
|
29
|
+
"**/*.ts",
|
|
30
|
+
"**/*.tsx",
|
|
31
|
+
"**/*.js",
|
|
32
|
+
"**/*.jsx"
|
|
33
|
+
],
|
|
34
|
+
"exclude": [
|
|
35
|
+
"node_modules",
|
|
36
|
+
"build",
|
|
37
|
+
"public",
|
|
38
|
+
"coverage",
|
|
39
|
+
"**/*.test.{js,jsx,ts,tsx}",
|
|
40
|
+
"**/*.spec.{js,jsx,ts,tsx}",
|
|
41
|
+
"**/*.stories.{js,jsx,ts,tsx}"
|
|
42
|
+
]
|
|
43
|
+
}
|
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
import fs from 'node:fs';
|
|
2
|
+
import path from 'node:path';
|
|
3
|
+
import { createRequire } from 'node:module';
|
|
4
|
+
import { fileURLToPath, pathToFileURL } from 'node:url';
|
|
5
|
+
import { defineConfig } from 'vitest/config';
|
|
6
|
+
import { transformWithEsbuild } from 'vite';
|
|
7
|
+
|
|
8
|
+
const __dirname = path.dirname(fileURLToPath(import.meta.url));
|
|
9
|
+
process.env.TZ = 'UTC';
|
|
10
|
+
// The nearest folder with a Volto checkout in `core/`: the add-on repository
|
|
11
|
+
// when developed standalone, or the frontend project when it is checked out
|
|
12
|
+
// in its `packages/` folder.
|
|
13
|
+
const findProjectRoot = (dir) => {
|
|
14
|
+
if (fs.existsSync(path.join(dir, 'core/packages/volto'))) return dir;
|
|
15
|
+
const parent = path.dirname(dir);
|
|
16
|
+
return parent === dir ? __dirname : findProjectRoot(parent);
|
|
17
|
+
};
|
|
18
|
+
const projectRoot = findProjectRoot(__dirname);
|
|
19
|
+
const voltoRoot = fs.existsSync(path.join(projectRoot, 'core/packages/volto'))
|
|
20
|
+
? path.join(projectRoot, 'core/packages/volto')
|
|
21
|
+
: path.dirname(
|
|
22
|
+
fileURLToPath(
|
|
23
|
+
import.meta.resolve('@plone/volto/package.json'),
|
|
24
|
+
),
|
|
25
|
+
);
|
|
26
|
+
const requireFromVolto = createRequire(path.join(voltoRoot, 'package.json'));
|
|
27
|
+
// The other core packages are dependencies of Volto, not of the add-on.
|
|
28
|
+
const resolveCorePackage = (name, folder) =>
|
|
29
|
+
fs.existsSync(path.join(projectRoot, 'core/packages', folder))
|
|
30
|
+
? path.join(projectRoot, 'core/packages', folder)
|
|
31
|
+
: path.dirname(requireFromVolto.resolve(`${name}/package.json`));
|
|
32
|
+
const voltoSlateRoot = resolveCorePackage('@plone/volto-slate', 'volto-slate');
|
|
33
|
+
const componentsRoot = resolveCorePackage('@plone/components', 'components');
|
|
34
|
+
const registryRoot = resolveCorePackage('@plone/registry', 'registry');
|
|
35
|
+
|
|
36
|
+
const requireFromAddon = createRequire(path.join(__dirname, 'package.json'));
|
|
37
|
+
const voltoPackage = JSON.parse(
|
|
38
|
+
fs.readFileSync(path.join(voltoRoot, 'package.json'), 'utf8'),
|
|
39
|
+
);
|
|
40
|
+
|
|
41
|
+
const baseConfig = (
|
|
42
|
+
await import(pathToFileURL(path.join(voltoRoot, 'vitest.config.mjs')).href)
|
|
43
|
+
).default;
|
|
44
|
+
const setupGlobals = fs.existsSync(
|
|
45
|
+
path.join(voltoRoot, 'test-setup-globals-vitest.js'),
|
|
46
|
+
)
|
|
47
|
+
? path.join(voltoRoot, 'test-setup-globals-vitest.js')
|
|
48
|
+
: path.join(voltoRoot, 'test-setup-globals.js');
|
|
49
|
+
const addonsLoader = fs.existsSync(
|
|
50
|
+
path.join(voltoRoot, 'test-addons-loader.js'),
|
|
51
|
+
)
|
|
52
|
+
? path.join(voltoRoot, 'test-addons-loader.js')
|
|
53
|
+
: path.join(voltoRoot, 'jest-addons-loader.js');
|
|
54
|
+
const setupFiles = [
|
|
55
|
+
setupGlobals,
|
|
56
|
+
path.join(voltoRoot, 'test-setup-config.jsx'),
|
|
57
|
+
];
|
|
58
|
+
const setupAfterEnv = path.join(voltoRoot, 'jest-setup-afterenv.js');
|
|
59
|
+
if (fs.existsSync(setupAfterEnv)) setupFiles.push(setupAfterEnv);
|
|
60
|
+
setupFiles.push(addonsLoader);
|
|
61
|
+
|
|
62
|
+
const globalsFile = path.join(__dirname, 'vitest.globals.js');
|
|
63
|
+
if (fs.existsSync(globalsFile)) setupFiles.push(globalsFile);
|
|
64
|
+
const envFile = path.join(__dirname, '.env');
|
|
65
|
+
const useAddonSetup =
|
|
66
|
+
!fs.existsSync(envFile) ||
|
|
67
|
+
/^VITEST_USE_SETUP=ON(?:\s|$)/m.test(fs.readFileSync(envFile, 'utf8'));
|
|
68
|
+
const addonSetup = path.join(__dirname, 'vitest.setup.jsx');
|
|
69
|
+
if (useAddonSetup && fs.existsSync(addonSetup)) setupFiles.push(addonSetup);
|
|
70
|
+
|
|
71
|
+
function resolvePackageRoot(packageName) {
|
|
72
|
+
for (const packageRequire of [requireFromAddon, requireFromVolto]) {
|
|
73
|
+
try {
|
|
74
|
+
return path.dirname(packageRequire.resolve(`${packageName}/package.json`));
|
|
75
|
+
} catch {
|
|
76
|
+
try {
|
|
77
|
+
let current = path.dirname(packageRequire.resolve(packageName));
|
|
78
|
+
while (current !== path.dirname(current)) {
|
|
79
|
+
const manifest = path.join(current, 'package.json');
|
|
80
|
+
if (fs.existsSync(manifest)) {
|
|
81
|
+
const candidate = JSON.parse(fs.readFileSync(manifest, 'utf8'));
|
|
82
|
+
if (candidate.name === packageName) return current;
|
|
83
|
+
}
|
|
84
|
+
current = path.dirname(current);
|
|
85
|
+
}
|
|
86
|
+
} catch {
|
|
87
|
+
// Try the next package resolution context.
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
return null;
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
const addonPackage = JSON.parse(
|
|
95
|
+
fs.readFileSync(path.join(__dirname, 'package.json'), 'utf8'),
|
|
96
|
+
);
|
|
97
|
+
const aliases = {
|
|
98
|
+
...(baseConfig.resolve?.alias ?? {}),
|
|
99
|
+
'@plone/volto': path.join(voltoRoot, 'src'),
|
|
100
|
+
'@plone/volto-slate': path.join(voltoSlateRoot, 'src'),
|
|
101
|
+
'@plone/components': path.join(componentsRoot, 'src'),
|
|
102
|
+
'@plone/registry': path.join(registryRoot, 'src'),
|
|
103
|
+
'@root': path.join(voltoRoot, 'src'),
|
|
104
|
+
'@package': path.join(__dirname, 'src'),
|
|
105
|
+
'~': path.join(voltoRoot, 'src'),
|
|
106
|
+
'load-volto-addons': addonsLoader,
|
|
107
|
+
[addonPackage.name]: path.join(__dirname, 'src'),
|
|
108
|
+
};
|
|
109
|
+
function addSourceAlias(packageRoot) {
|
|
110
|
+
const manifestPath = path.join(packageRoot, 'package.json');
|
|
111
|
+
const sourceRoot = path.join(packageRoot, 'src');
|
|
112
|
+
if (!fs.existsSync(manifestPath) || !fs.existsSync(sourceRoot)) return;
|
|
113
|
+
const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
|
|
114
|
+
if (manifest.name) aliases[manifest.name] = sourceRoot;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
const workspacePackages = path.join(projectRoot, 'packages');
|
|
118
|
+
if (fs.existsSync(workspacePackages)) {
|
|
119
|
+
for (const packageDirectory of fs.readdirSync(workspacePackages)) {
|
|
120
|
+
const packageRoot = path.join(workspacePackages, packageDirectory);
|
|
121
|
+
addSourceAlias(packageRoot);
|
|
122
|
+
// In a frontend project each add-on repository keeps its add-on in its
|
|
123
|
+
// own `packages/` folder.
|
|
124
|
+
const nestedPackages = path.join(packageRoot, 'packages');
|
|
125
|
+
if (fs.existsSync(nestedPackages)) {
|
|
126
|
+
for (const nestedDirectory of fs.readdirSync(nestedPackages)) {
|
|
127
|
+
addSourceAlias(path.join(nestedPackages, nestedDirectory));
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
}
|
|
132
|
+
const pnpmStore = path.join(projectRoot, 'node_modules/.pnpm');
|
|
133
|
+
if (fs.existsSync(pnpmStore)) {
|
|
134
|
+
for (const storeDirectory of fs.readdirSync(pnpmStore)) {
|
|
135
|
+
for (const scope of ['@eeacms', '@plone-collective']) {
|
|
136
|
+
const scopeRoot = path.join(
|
|
137
|
+
pnpmStore,
|
|
138
|
+
storeDirectory,
|
|
139
|
+
'node_modules',
|
|
140
|
+
scope,
|
|
141
|
+
);
|
|
142
|
+
if (!fs.existsSync(scopeRoot)) continue;
|
|
143
|
+
for (const packageDirectory of fs.readdirSync(scopeRoot)) {
|
|
144
|
+
addSourceAlias(path.join(scopeRoot, packageDirectory));
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
const excludedVoltoAliases = [
|
|
151
|
+
'vitest',
|
|
152
|
+
'vite',
|
|
153
|
+
'jsdom',
|
|
154
|
+
'@vitejs/plugin-react',
|
|
155
|
+
];
|
|
156
|
+
for (const dependency of Object.keys({
|
|
157
|
+
...(voltoPackage.dependencies ?? {}),
|
|
158
|
+
...(voltoPackage.devDependencies ?? {}),
|
|
159
|
+
})) {
|
|
160
|
+
if (
|
|
161
|
+
dependency in aliases ||
|
|
162
|
+
excludedVoltoAliases.includes(dependency) ||
|
|
163
|
+
dependency.startsWith('@vitest/') ||
|
|
164
|
+
dependency.startsWith('@testing-library/')
|
|
165
|
+
) {
|
|
166
|
+
continue;
|
|
167
|
+
}
|
|
168
|
+
const dependencyRoot = resolvePackageRoot(dependency);
|
|
169
|
+
if (dependencyRoot) aliases[dependency] = dependencyRoot;
|
|
170
|
+
}
|
|
171
|
+
const workspaceSearchlib = [
|
|
172
|
+
'packages/volto-searchlib/searchlib',
|
|
173
|
+
'packages/volto-searchlib/packages/volto-searchlib/searchlib',
|
|
174
|
+
]
|
|
175
|
+
.map((searchlibFolder) => path.join(projectRoot, searchlibFolder))
|
|
176
|
+
.find((searchlibFolder) => fs.existsSync(searchlibFolder));
|
|
177
|
+
const installedSearchlib = resolvePackageRoot('@eeacms/volto-searchlib');
|
|
178
|
+
const searchlibPath = fs.existsSync(workspaceSearchlib)
|
|
179
|
+
? workspaceSearchlib
|
|
180
|
+
: fs.existsSync(path.join(__dirname, 'searchlib'))
|
|
181
|
+
? path.join(__dirname, 'searchlib')
|
|
182
|
+
: installedSearchlib
|
|
183
|
+
? path.join(installedSearchlib, 'searchlib')
|
|
184
|
+
: '';
|
|
185
|
+
if (fs.existsSync(searchlibPath)) aliases['@eeacms/search'] = searchlibPath;
|
|
186
|
+
const subsitesMock = path.join(
|
|
187
|
+
__dirname,
|
|
188
|
+
'src/__mocks__/volto-subsites-utils.js',
|
|
189
|
+
);
|
|
190
|
+
if (fs.existsSync(subsitesMock)) aliases['volto-subsites/utils'] = subsitesMock;
|
|
191
|
+
const localStorageMock = path.join(
|
|
192
|
+
__dirname,
|
|
193
|
+
'src/__mocks__/redux-localstorage-simple-original.js',
|
|
194
|
+
);
|
|
195
|
+
if (fs.existsSync(localStorageMock)) {
|
|
196
|
+
aliases['redux-localstorage-simple-original'] = localStorageMock;
|
|
197
|
+
}
|
|
198
|
+
const uuidMock = path.join(__dirname, 'vitest.uuid.mock.js');
|
|
199
|
+
if (fs.existsSync(uuidMock)) aliases.uuid = uuidMock;
|
|
200
|
+
const jsxSourceRoots = Object.values(aliases).filter(
|
|
201
|
+
(aliasPath) => typeof aliasPath === 'string',
|
|
202
|
+
);
|
|
203
|
+
|
|
204
|
+
const jsxInJsPlugin = {
|
|
205
|
+
name: 'eea-addon-jsx-in-js',
|
|
206
|
+
enforce: 'pre',
|
|
207
|
+
transform(code, id) {
|
|
208
|
+
const filePath = id.split('?')[0];
|
|
209
|
+
if (
|
|
210
|
+
!filePath.endsWith('.js') ||
|
|
211
|
+
!jsxSourceRoots.some(
|
|
212
|
+
(sourceRoot) =>
|
|
213
|
+
filePath === sourceRoot ||
|
|
214
|
+
filePath.startsWith(`${sourceRoot}${path.sep}`),
|
|
215
|
+
)
|
|
216
|
+
) {
|
|
217
|
+
return null;
|
|
218
|
+
}
|
|
219
|
+
return transformWithEsbuild(code, filePath, {
|
|
220
|
+
loader: 'jsx',
|
|
221
|
+
jsx: 'automatic',
|
|
222
|
+
});
|
|
223
|
+
},
|
|
224
|
+
};
|
|
225
|
+
|
|
226
|
+
export default defineConfig({
|
|
227
|
+
plugins: [jsxInJsPlugin, ...(baseConfig.plugins ?? [])],
|
|
228
|
+
define: {
|
|
229
|
+
__CLIENT__: true,
|
|
230
|
+
__DEVELOPMENT__: false,
|
|
231
|
+
__SERVER__: false,
|
|
232
|
+
__TEST__: true,
|
|
233
|
+
},
|
|
234
|
+
resolve: { alias: aliases },
|
|
235
|
+
server: {
|
|
236
|
+
fs: {
|
|
237
|
+
allow: [projectRoot, __dirname],
|
|
238
|
+
},
|
|
239
|
+
deps: {
|
|
240
|
+
inline: [/@eeacms/, /@plone/, /query-string/],
|
|
241
|
+
},
|
|
242
|
+
},
|
|
243
|
+
test: {
|
|
244
|
+
root: __dirname,
|
|
245
|
+
isolate: true,
|
|
246
|
+
globals: true,
|
|
247
|
+
environment: 'jsdom',
|
|
248
|
+
css: false,
|
|
249
|
+
setupFiles,
|
|
250
|
+
include: [
|
|
251
|
+
'src/**/*.{test,spec}.{js,jsx,ts,tsx}',
|
|
252
|
+
'searchlib/**/*.{test,spec}.{js,jsx,ts,tsx}',
|
|
253
|
+
],
|
|
254
|
+
passWithNoTests: true,
|
|
255
|
+
snapshotFormat: baseConfig.test?.snapshotFormat ?? {
|
|
256
|
+
printBasicPrototype: false,
|
|
257
|
+
},
|
|
258
|
+
coverage: {
|
|
259
|
+
provider: 'istanbul',
|
|
260
|
+
reporter: ['text', 'lcov', 'html', 'cobertura'],
|
|
261
|
+
reportsDirectory: process.env.COVERAGE_DIR ?? 'coverage',
|
|
262
|
+
include: [
|
|
263
|
+
'src/**/*.{js,jsx,ts,tsx}',
|
|
264
|
+
'searchlib/**/*.{js,jsx,ts,tsx}',
|
|
265
|
+
],
|
|
266
|
+
exclude: [
|
|
267
|
+
'src/**/*.{test,spec}.{js,jsx,ts,tsx}',
|
|
268
|
+
'src/**/__tests__/**',
|
|
269
|
+
'src/**/__mocks__/**',
|
|
270
|
+
'src/**/*.d.ts',
|
|
271
|
+
'src/**/index.{js,jsx,ts,tsx}',
|
|
272
|
+
'src/**/*config.{js,jsx,ts,tsx}',
|
|
273
|
+
'src/**/*schema.{js,jsx,ts,tsx}',
|
|
274
|
+
],
|
|
275
|
+
thresholds: {
|
|
276
|
+
branches: 5,
|
|
277
|
+
functions: 5,
|
|
278
|
+
lines: 5,
|
|
279
|
+
statements: 5,
|
|
280
|
+
},
|
|
281
|
+
},
|
|
282
|
+
},
|
|
283
|
+
});
|
package/vitest.setup.jsx
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { vi } from 'vitest';
|
|
2
|
+
import configureStore from 'redux-mock-store';
|
|
3
|
+
import thunk from 'redux-thunk';
|
|
4
|
+
import { blocksConfig } from '@plone/volto/config/Blocks';
|
|
5
|
+
import installSlate from '@plone/volto-slate/index';
|
|
6
|
+
|
|
7
|
+
global.jest = vi;
|
|
8
|
+
|
|
9
|
+
const mockSemanticComponents = await vi.importActual('semantic-ui-react');
|
|
10
|
+
const mockComponents = await vi.importActual('@plone/volto/components');
|
|
11
|
+
const config = (await vi.importActual('@plone/volto/registry')).default;
|
|
12
|
+
|
|
13
|
+
config.blocks.blocksConfig = {
|
|
14
|
+
...blocksConfig,
|
|
15
|
+
...config.blocks.blocksConfig,
|
|
16
|
+
};
|
|
17
|
+
|
|
18
|
+
vi.doMock('semantic-ui-react', () => ({
|
|
19
|
+
__esModule: true,
|
|
20
|
+
...mockSemanticComponents,
|
|
21
|
+
Popup: ({ content, trigger }) => (
|
|
22
|
+
<div className="popup">
|
|
23
|
+
<div className="trigger">{trigger}</div>
|
|
24
|
+
<div className="content">{content}</div>
|
|
25
|
+
</div>
|
|
26
|
+
),
|
|
27
|
+
}));
|
|
28
|
+
|
|
29
|
+
vi.doMock('@plone/volto/components', () => ({
|
|
30
|
+
__esModule: true,
|
|
31
|
+
...mockComponents,
|
|
32
|
+
SidebarPortal: ({ children }) => <div id="sidebar">{children}</div>,
|
|
33
|
+
}));
|
|
34
|
+
|
|
35
|
+
vi.doMock('@plone/volto/registry', () => ({
|
|
36
|
+
__esModule: true,
|
|
37
|
+
default: [installSlate].reduce((acc, apply) => apply(acc), config),
|
|
38
|
+
}));
|
|
39
|
+
|
|
40
|
+
const mockStore = configureStore([thunk]);
|
|
41
|
+
|
|
42
|
+
global.fetch = vi.fn(() =>
|
|
43
|
+
Promise.resolve({
|
|
44
|
+
json: () => Promise.resolve({}),
|
|
45
|
+
}),
|
|
46
|
+
);
|
|
47
|
+
|
|
48
|
+
global.store = mockStore({
|
|
49
|
+
intl: {
|
|
50
|
+
locale: 'en',
|
|
51
|
+
messages: {},
|
|
52
|
+
formatMessage: vi.fn(),
|
|
53
|
+
},
|
|
54
|
+
content: {
|
|
55
|
+
create: {},
|
|
56
|
+
subrequests: [],
|
|
57
|
+
},
|
|
58
|
+
connected_data_parameters: {},
|
|
59
|
+
screen: {
|
|
60
|
+
page: {
|
|
61
|
+
width: 768,
|
|
62
|
+
},
|
|
63
|
+
},
|
|
64
|
+
});
|
package/.eslintrc.js
DELETED
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
const fs = require('fs');
|
|
2
|
-
const path = require('path');
|
|
3
|
-
const projectRootPath = fs.realpathSync(__dirname + '/../../../');
|
|
4
|
-
|
|
5
|
-
let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto');
|
|
6
|
-
let configFile;
|
|
7
|
-
if (fs.existsSync(`${projectRootPath}/tsconfig.json`))
|
|
8
|
-
configFile = `${projectRootPath}/tsconfig.json`;
|
|
9
|
-
else if (fs.existsSync(`${projectRootPath}/jsconfig.json`))
|
|
10
|
-
configFile = `${projectRootPath}/jsconfig.json`;
|
|
11
|
-
|
|
12
|
-
if (configFile) {
|
|
13
|
-
const jsConfig = require(configFile).compilerOptions;
|
|
14
|
-
const pathsConfig = jsConfig.paths;
|
|
15
|
-
if (pathsConfig['@plone/volto'])
|
|
16
|
-
voltoPath = `./${jsConfig.baseUrl}/${pathsConfig['@plone/volto'][0]}`;
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
const AddonConfigurationRegistry = require(`${voltoPath}/addon-registry.js`);
|
|
20
|
-
const reg = new AddonConfigurationRegistry(projectRootPath);
|
|
21
|
-
|
|
22
|
-
// Extends ESlint configuration for adding the aliases to `src` directories in Volto addons
|
|
23
|
-
const addonAliases = Object.keys(reg.packages).map((o) => [
|
|
24
|
-
o,
|
|
25
|
-
reg.packages[o].modulePath,
|
|
26
|
-
]);
|
|
27
|
-
|
|
28
|
-
const addonExtenders = reg.getEslintExtenders().map((m) => require(m));
|
|
29
|
-
|
|
30
|
-
const defaultConfig = {
|
|
31
|
-
extends: `${voltoPath}/.eslintrc`,
|
|
32
|
-
settings: {
|
|
33
|
-
'import/resolver': {
|
|
34
|
-
alias: {
|
|
35
|
-
map: [
|
|
36
|
-
['@plone/volto', '@plone/volto/src'],
|
|
37
|
-
['@plone/volto-slate', '@plone/volto/packages/volto-slate/src'],
|
|
38
|
-
...addonAliases,
|
|
39
|
-
['@package', `${__dirname}/src`],
|
|
40
|
-
['@root', `${__dirname}/src`],
|
|
41
|
-
['~', `${__dirname}/src`],
|
|
42
|
-
],
|
|
43
|
-
extensions: ['.js', '.jsx', '.json'],
|
|
44
|
-
},
|
|
45
|
-
'babel-plugin-root-import': {
|
|
46
|
-
rootPathSuffix: 'src',
|
|
47
|
-
},
|
|
48
|
-
},
|
|
49
|
-
},
|
|
50
|
-
rules: {
|
|
51
|
-
'react/jsx-no-target-blank': [
|
|
52
|
-
'error',
|
|
53
|
-
{
|
|
54
|
-
allowReferrer: true,
|
|
55
|
-
},
|
|
56
|
-
],
|
|
57
|
-
}
|
|
58
|
-
};
|
|
59
|
-
|
|
60
|
-
const config = addonExtenders.reduce(
|
|
61
|
-
(acc, extender) => extender.modify(acc),
|
|
62
|
-
defaultConfig,
|
|
63
|
-
);
|
|
64
|
-
|
|
65
|
-
module.exports = config;
|
package/.husky/pre-commit
DELETED
package/DEVELOP.md
DELETED
|
@@ -1,108 +0,0 @@
|
|
|
1
|
-
# volto-widget-toggle
|
|
2
|
-
|
|
3
|
-
## Develop
|
|
4
|
-
|
|
5
|
-
1. Make sure you have `docker` and `docker compose` installed and running on your machine:
|
|
6
|
-
|
|
7
|
-
```Bash
|
|
8
|
-
git clone https://github.com/eea/volto-widget-toggle.git
|
|
9
|
-
cd volto-widget-toggle
|
|
10
|
-
git checkout -b bugfix-123456 develop
|
|
11
|
-
make
|
|
12
|
-
make start
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
1. Wait for `Volto started at 0.0.0.0:3000` meesage
|
|
16
|
-
|
|
17
|
-
1. Go to http://localhost:3000
|
|
18
|
-
|
|
19
|
-
1. Initialize git hooks
|
|
20
|
-
|
|
21
|
-
```Bash
|
|
22
|
-
yarn prepare
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
1. Happy hacking!
|
|
26
|
-
|
|
27
|
-
### Or add @eeacms/volto-widget-toggle to your Volto project
|
|
28
|
-
|
|
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
|
-
|
|
31
|
-
For new Volto 18+ projects, use Cookieplone. It includes `mrs-developer` by default.
|
|
32
|
-
|
|
33
|
-
1. Create a new Volto project with Cookieplone
|
|
34
|
-
|
|
35
|
-
uvx cookieplone project
|
|
36
|
-
cd project-title
|
|
37
|
-
|
|
38
|
-
1. Add the following to `mrs.developer.json`:
|
|
39
|
-
|
|
40
|
-
{
|
|
41
|
-
"volto-widget-toggle": {
|
|
42
|
-
"output": "packages",
|
|
43
|
-
"url": "https://github.com/eea/volto-widget-toggle.git",
|
|
44
|
-
"package": "@eeacms/volto-widget-toggle",
|
|
45
|
-
"branch": "develop",
|
|
46
|
-
"path": "src"
|
|
47
|
-
}
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
1. Add `@eeacms/volto-widget-toggle` to the `addons` key in your project `volto.config.js`
|
|
51
|
-
|
|
52
|
-
1. Install or refresh the project setup
|
|
53
|
-
|
|
54
|
-
make install
|
|
55
|
-
|
|
56
|
-
1. Start backend in one terminal
|
|
57
|
-
|
|
58
|
-
make backend-start
|
|
59
|
-
|
|
60
|
-
...wait for backend to setup and start, ending with `Ready to handle requests`
|
|
61
|
-
|
|
62
|
-
...you can also check http://localhost:8080/Plone
|
|
63
|
-
|
|
64
|
-
1. Start frontend in a second terminal
|
|
65
|
-
|
|
66
|
-
make frontend-start
|
|
67
|
-
|
|
68
|
-
1. Go to http://localhost:3000
|
|
69
|
-
|
|
70
|
-
1. Happy hacking!
|
|
71
|
-
|
|
72
|
-
cd packages/volto-widget-toggle
|
|
73
|
-
|
|
74
|
-
For legacy Volto 17 projects, keep using the yarn-based workflow from the Volto 17 documentation.
|
|
75
|
-
|
|
76
|
-
## Cypress
|
|
77
|
-
|
|
78
|
-
To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
|
|
79
|
-
|
|
80
|
-
You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
|
|
81
|
-
project where you added `volto-widget-toggle` to `mrs.developer.json`
|
|
82
|
-
|
|
83
|
-
Go to:
|
|
84
|
-
|
|
85
|
-
```BASH
|
|
86
|
-
cd packages/volto-widget-toggle/
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
Start:
|
|
90
|
-
|
|
91
|
-
```Bash
|
|
92
|
-
make
|
|
93
|
-
make start
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-widget-toggle` block installed.
|
|
97
|
-
|
|
98
|
-
Open Cypress Interface:
|
|
99
|
-
|
|
100
|
-
```Bash
|
|
101
|
-
make cypress-open
|
|
102
|
-
```
|
|
103
|
-
|
|
104
|
-
Or run it:
|
|
105
|
-
|
|
106
|
-
```Bash
|
|
107
|
-
make cypress-run
|
|
108
|
-
```
|
package/RELEASE.md
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
## Release
|
|
2
|
-
|
|
3
|
-
### Automatic release using Jenkins
|
|
4
|
-
|
|
5
|
-
* The automatic release is started by creating a [Pull Request](../../compare/master...develop) from `develop` to `master`. The pull request status checks correlated to the branch and PR Jenkins jobs need to be processed successfully. 1 review from a github user with rights is mandatory.
|
|
6
|
-
* It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits.
|
|
7
|
-
* The automatic release is done by [Jenkins](https://ci.eionet.europa.eu). The status of the release job can be seen both in the Readme.md badges and the green check/red cross/yellow circle near the last commit information. If you click on the icon, you will have the list of checks that were run. The `continuous-integration/jenkins/branch` link goes to the Jenkins job execution webpage.
|
|
8
|
-
* Automated release scripts are located in the `eeacms/gitflow` docker image, specifically [js-release.sh](https://github.com/eea/eea.docker.gitflow/blob/master/src/js-release.sh) script. It uses the `release-it` tool.
|
|
9
|
-
* As long as a PR request is open from develop to master, the PR Jenkins job will automatically re-create the CHANGELOG.md and package.json files to be production-ready.
|
|
10
|
-
* The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).
|
|
11
|
-
* You can manually change the version in `package.json`. The new version must not be already present in the tags/releases of the repository, otherwise it will be automatically increased by the script. Any changes to the version will trigger a `CHANGELOG.md` re-generation.
|
|
12
|
-
* Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file.
|
|
13
|
-
|
|
14
|
-
### Manual release from the develop branch ( beta release )
|
|
15
|
-
|
|
16
|
-
#### Installation and configuration of release-it
|
|
17
|
-
|
|
18
|
-
You need to first install the [release-it](https://github.com/release-it/release-it) client.
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
npm install -g release-it
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository.
|
|
25
|
-
|
|
26
|
-
Release-it is a tool that automates 4 important steps in the release process:
|
|
27
|
-
|
|
28
|
-
1. Version increase in `package.json` ( increased from the current version in `package.json`)
|
|
29
|
-
2. `CHANGELOG.md` automatic generation from commit messages ( grouped by releases )
|
|
30
|
-
3. GitHub release on the commit with the changelog and package.json modification on the develop branch
|
|
31
|
-
4. NPM release ( by default it's disabled, but can be enabled in the configuration file )
|
|
32
|
-
|
|
33
|
-
To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens)
|
|
34
|
-
|
|
35
|
-
```
|
|
36
|
-
export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :
|
|
40
|
-
|
|
41
|
-
```
|
|
42
|
-
echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
#### Using release-it tool
|
|
46
|
-
|
|
47
|
-
There are 3 yarn scripts that can be run to do the release
|
|
48
|
-
|
|
49
|
-
##### yarn release-beta
|
|
50
|
-
|
|
51
|
-
Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input).
|
|
52
|
-
|
|
53
|
-
```
|
|
54
|
-
? Select increment (next version):
|
|
55
|
-
❯ prepatch (0.1.1-beta.0)
|
|
56
|
-
preminor (0.2.0-beta.0)
|
|
57
|
-
premajor (1.0.0-beta.0)
|
|
58
|
-
Other, please specify...
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
##### yarn release-major-beta
|
|
62
|
-
|
|
63
|
-
Same as `yarn release-beta`, but with premajor version pre-selected.
|
|
64
|
-
|
|
65
|
-
##### yarn release
|
|
66
|
-
|
|
67
|
-
Generic command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other.
|
|
68
|
-
|
|
69
|
-
#### Important notes
|
|
70
|
-
|
|
71
|
-
> Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST.
|
|
72
|
-
|
|
73
|
-
> Do not keep Pull Requests from develop to master branches open when you are doing beta releases from the develop branch. As long as a PR to master is open, an automatic script will run on every commit and will update both the version and the changelog to a production-ready state - ( MAJOR.MINOR.PATCH mandatory format for version).
|
|
74
|
-
|
package/bootstrap
DELETED
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
const path = require('path');
|
|
2
|
-
const fs = require('fs');
|
|
3
|
-
const ejs = require('ejs');
|
|
4
|
-
|
|
5
|
-
const currentDir = path.basename(process.cwd());
|
|
6
|
-
|
|
7
|
-
const bootstrap = function (ofile) {
|
|
8
|
-
fs.readFile(ofile, 'utf8', function (err, data) {
|
|
9
|
-
if (err) {
|
|
10
|
-
return console.log(err);
|
|
11
|
-
}
|
|
12
|
-
const result = ejs.render(data, {
|
|
13
|
-
addonName: `@eeacms/${currentDir}`,
|
|
14
|
-
name: currentDir
|
|
15
|
-
});
|
|
16
|
-
const output = ofile.replace('.tpl', '');
|
|
17
|
-
fs.writeFile(output, result, 'utf8', function (err) {
|
|
18
|
-
if (err) {
|
|
19
|
-
return console.log(err);
|
|
20
|
-
}
|
|
21
|
-
});
|
|
22
|
-
if (ofile.includes('.tpl')) {
|
|
23
|
-
fs.unlink(ofile, (err) => {
|
|
24
|
-
if (err) {
|
|
25
|
-
return console.error(err);
|
|
26
|
-
}
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
|
-
});
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
fs.readdir(".", { withFileTypes: true }, (err, dirents) => {
|
|
33
|
-
const files = dirents
|
|
34
|
-
.filter(dirent => dirent.isFile())
|
|
35
|
-
.map(dirent => dirent.name);
|
|
36
|
-
files.forEach(function (file) {
|
|
37
|
-
if (file != 'bootstrap') {
|
|
38
|
-
bootstrap(file);
|
|
39
|
-
}
|
|
40
|
-
});
|
|
41
|
-
});
|
package/cypress.config.js
DELETED
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
const { defineConfig } = require('cypress');
|
|
2
|
-
|
|
3
|
-
module.exports = defineConfig({
|
|
4
|
-
viewportWidth: 1280,
|
|
5
|
-
defaultCommandTimeout: 8888,
|
|
6
|
-
chromeWebSecurity: false,
|
|
7
|
-
reporter: 'junit',
|
|
8
|
-
video: false,
|
|
9
|
-
retries: {
|
|
10
|
-
runMode: 2,
|
|
11
|
-
openMode: 0,
|
|
12
|
-
},
|
|
13
|
-
reporterOptions: {
|
|
14
|
-
mochaFile: 'cypress/reports/cypress-[hash].xml',
|
|
15
|
-
jenkinsMode: true,
|
|
16
|
-
toConsole: true,
|
|
17
|
-
},
|
|
18
|
-
e2e: {
|
|
19
|
-
setupNodeEvents(on, config) {
|
|
20
|
-
// e2e testing node events setup code
|
|
21
|
-
require('@cypress/code-coverage/task')(on, config);
|
|
22
|
-
return config;
|
|
23
|
-
},
|
|
24
|
-
baseUrl: 'http://localhost:3000',
|
|
25
|
-
},
|
|
26
|
-
});
|
package/docker-compose.yml
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
version: "3"
|
|
2
|
-
services:
|
|
3
|
-
backend:
|
|
4
|
-
image: eeacms/plone-backend
|
|
5
|
-
ports:
|
|
6
|
-
- "8080:8080"
|
|
7
|
-
environment:
|
|
8
|
-
SITE: "Plone"
|
|
9
|
-
PROFILES: "eea.kitkat:testing"
|
|
10
|
-
|
|
11
|
-
frontend:
|
|
12
|
-
build:
|
|
13
|
-
context: ./
|
|
14
|
-
dockerfile: ./Dockerfile
|
|
15
|
-
args:
|
|
16
|
-
ADDON_NAME: "${ADDON_NAME}"
|
|
17
|
-
ADDON_PATH: "${ADDON_PATH}"
|
|
18
|
-
VOLTO_VERSION: ${VOLTO_VERSION:-18-yarn}
|
|
19
|
-
ports:
|
|
20
|
-
- "3000:3000"
|
|
21
|
-
- "3001:3001"
|
|
22
|
-
depends_on:
|
|
23
|
-
- backend
|
|
24
|
-
volumes:
|
|
25
|
-
- ./:/app/src/addons/${ADDON_PATH}
|
|
26
|
-
environment:
|
|
27
|
-
CI: "true"
|
|
28
|
-
NODE_ENV: "development"
|
|
29
|
-
RAZZLE_JEST_CONFIG: "src/addons/${ADDON_PATH}/jest-addon.config.js"
|
|
30
|
-
RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone"
|
|
31
|
-
RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone"
|
|
32
|
-
HOST: "0.0.0.0"
|
package/jest-addon.config.js
DELETED
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
require('dotenv').config({ path: __dirname + '/.env' })
|
|
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
|
-
|
|
12
|
-
module.exports = {
|
|
13
|
-
testMatch: ['**/src/addons/**/?(*.)+(spec|test).[jt]s?(x)'],
|
|
14
|
-
collectCoverageFrom: [
|
|
15
|
-
'src/addons/**/src/**/*.{js,jsx,ts,tsx}',
|
|
16
|
-
'!src/**/*.d.ts',
|
|
17
|
-
],
|
|
18
|
-
moduleNameMapper: {
|
|
19
|
-
'\\.(css|less|scss|sass)$': 'identity-obj-proxy',
|
|
20
|
-
'@plone/volto/cypress': '<rootDir>/node_modules/@plone/volto/cypress',
|
|
21
|
-
'@plone/volto/babel': '<rootDir>/node_modules/@plone/volto/babel',
|
|
22
|
-
'@plone/volto/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
|
|
23
|
-
'@package/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
|
|
24
|
-
'@root/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
|
|
25
|
-
'@plone/volto-quanta/(.*)$': '<rootDir>/src/addons/volto-quanta/src/$1',
|
|
26
|
-
'@eeacms/search/(.*)$': '<rootDir>/src/addons/volto-searchlib/searchlib/$1',
|
|
27
|
-
'@eeacms/search': '<rootDir>/src/addons/volto-searchlib/searchlib',
|
|
28
|
-
'@eeacms/(.*?)/(.*)$': '<rootDir>/node_modules/@eeacms/$1/src/$2',
|
|
29
|
-
'@plone/volto-slate$': voltoSlatePath,
|
|
30
|
-
'@plone/volto-slate/(.*)$': `${voltoSlatePath}/$1`,
|
|
31
|
-
'~/(.*)$': '<rootDir>/src/$1',
|
|
32
|
-
'load-volto-addons':
|
|
33
|
-
'<rootDir>/node_modules/@plone/volto/jest-addons-loader.js',
|
|
34
|
-
},
|
|
35
|
-
transformIgnorePatterns: [
|
|
36
|
-
'/node_modules/(?!(@plone|@root|@package|@eeacms)/).*/',
|
|
37
|
-
],
|
|
38
|
-
transform: {
|
|
39
|
-
'^.+\\.js(x)?$': 'babel-jest',
|
|
40
|
-
'^.+\\.ts(x)?$': 'babel-jest',
|
|
41
|
-
'^.+\\.(png)$': 'jest-file',
|
|
42
|
-
'^.+\\.(jpg)$': 'jest-file',
|
|
43
|
-
'^.+\\.(svg)$': './node_modules/@plone/volto/jest-svgsystem-transform.js',
|
|
44
|
-
},
|
|
45
|
-
coverageThreshold: {
|
|
46
|
-
global: {
|
|
47
|
-
branches: 5,
|
|
48
|
-
functions: 5,
|
|
49
|
-
lines: 5,
|
|
50
|
-
statements: 5,
|
|
51
|
-
},
|
|
52
|
-
},
|
|
53
|
-
...(process.env.JEST_USE_SETUP === 'ON' && {
|
|
54
|
-
setupFilesAfterEnv: [
|
|
55
|
-
'<rootDir>/node_modules/@eeacms/volto-widget-toggle/jest.setup.js',
|
|
56
|
-
],
|
|
57
|
-
}),
|
|
58
|
-
}
|
package/jest.setup.js
DELETED
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import { jest } from '@jest/globals';
|
|
2
|
-
import configureStore from 'redux-mock-store';
|
|
3
|
-
import thunk from 'redux-thunk';
|
|
4
|
-
import { blocksConfig } from '@plone/volto/config/Blocks';
|
|
5
|
-
import installSlate from '@plone/volto-slate/index';
|
|
6
|
-
|
|
7
|
-
var mockSemanticComponents = jest.requireActual('semantic-ui-react');
|
|
8
|
-
var mockComponents = jest.requireActual('@plone/volto/components');
|
|
9
|
-
var config = jest.requireActual('@plone/volto/registry').default;
|
|
10
|
-
|
|
11
|
-
config.blocks.blocksConfig = {
|
|
12
|
-
...blocksConfig,
|
|
13
|
-
...config.blocks.blocksConfig,
|
|
14
|
-
};
|
|
15
|
-
|
|
16
|
-
jest.doMock('semantic-ui-react', () => ({
|
|
17
|
-
__esModule: true,
|
|
18
|
-
...mockSemanticComponents,
|
|
19
|
-
Popup: ({ content, trigger }) => {
|
|
20
|
-
return (
|
|
21
|
-
<div className="popup">
|
|
22
|
-
<div className="trigger">{trigger}</div>
|
|
23
|
-
<div className="content">{content}</div>
|
|
24
|
-
</div>
|
|
25
|
-
);
|
|
26
|
-
},
|
|
27
|
-
}));
|
|
28
|
-
|
|
29
|
-
jest.doMock('@plone/volto/components', () => {
|
|
30
|
-
return {
|
|
31
|
-
__esModule: true,
|
|
32
|
-
...mockComponents,
|
|
33
|
-
SidebarPortal: ({ children }) => <div id="sidebar">{children}</div>,
|
|
34
|
-
};
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
jest.doMock('@plone/volto/registry', () =>
|
|
38
|
-
[installSlate].reduce((acc, apply) => apply(acc), config),
|
|
39
|
-
);
|
|
40
|
-
|
|
41
|
-
const mockStore = configureStore([thunk]);
|
|
42
|
-
|
|
43
|
-
global.fetch = jest.fn(() =>
|
|
44
|
-
Promise.resolve({
|
|
45
|
-
json: () => Promise.resolve({}),
|
|
46
|
-
}),
|
|
47
|
-
);
|
|
48
|
-
|
|
49
|
-
global.store = mockStore({
|
|
50
|
-
intl: {
|
|
51
|
-
locale: 'en',
|
|
52
|
-
messages: {},
|
|
53
|
-
formatMessage: jest.fn(),
|
|
54
|
-
},
|
|
55
|
-
content: {
|
|
56
|
-
create: {},
|
|
57
|
-
subrequests: [],
|
|
58
|
-
},
|
|
59
|
-
connected_data_parameters: {},
|
|
60
|
-
screen: {
|
|
61
|
-
page: {
|
|
62
|
-
width: 768,
|
|
63
|
-
},
|
|
64
|
-
},
|
|
65
|
-
});
|