@eeacms/volto-eea-kitkat 4.1.3 → 4.1.7

package/CHANGELOG.md

@@ -4,8 +4,50 @@ 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).
 
+#### [4.1.7](https://github.com/eea/volto-eea-kitkat/compare/4.1.6...4.1.7)
+
+- Cleanup obsolte i18n script [`8d8896d`](https://github.com/eea/volto-eea-kitkat/commit/8d8896db6227ec14eb536cee4b632cdeeeed56aa)
+
+#### [4.1.6](https://github.com/eea/volto-eea-kitkat/compare/4.1.5...4.1.6)
+
+> 24 November 2021
+
+- Develop [`#19`](https://github.com/eea/volto-eea-kitkat/pull/19)
+- Cypress tests in child addons [`#18`](https://github.com/eea/volto-eea-kitkat/pull/18)
+- screenshotOnRunFailure: false [`de33099`](https://github.com/eea/volto-eea-kitkat/commit/de330994f12db6e0436ddfcfa0dc173ddeff3778)
+- cy: upload video on failure [`b3c2b46`](https://github.com/eea/volto-eea-kitkat/commit/b3c2b464b14baf5e2a972bc001f5872288faa0a8)
+- Refs #142010 - Optimize Volto-addons gitflow pipelines [`8494683`](https://github.com/eea/volto-eea-kitkat/commit/84946833bfc87dac06ce38a23665b42addafdcfe)
+- archive cypress-reports/videos [`ffa28b1`](https://github.com/eea/volto-eea-kitkat/commit/ffa28b10234ba316ffd7e133a94117e2e0f240ae)
+- Release @eeacms/volto-accordion-block@3.4.8 [`9c99f2b`](https://github.com/eea/volto-eea-kitkat/commit/9c99f2b4ae946baa1c0190efff44ee547565b16a)
+- shift configs -> cypress.json [`8c2ff75`](https://github.com/eea/volto-eea-kitkat/commit/8c2ff758fabf7a156d50ce179555862fec1cad3e)
+- run cypress in child addons [`4a29e33`](https://github.com/eea/volto-eea-kitkat/commit/4a29e33c9ebfc2ca039e9da34bab55e58dc007d3)
+
+#### [4.1.5](https://github.com/eea/volto-eea-kitkat/compare/4.1.4...4.1.5)
+
+> 19 November 2021
+
+- Addons updates [`#17`](https://github.com/eea/volto-eea-kitkat/pull/17)
+- Release @eeacms/volto-block-style@3.5.3 [`6ca12a3`](https://github.com/eea/volto-eea-kitkat/commit/6ca12a382fbb5d8f7662fb5ba7169e5640b056c3)
+- Revert "Release volto-slate@5.1.1" [`fff322e`](https://github.com/eea/volto-eea-kitkat/commit/fff322e60cbb11639bb0987eaad3500225cfa9b8)
+- Release volto-slate@5.1.1 [`39a8899`](https://github.com/eea/volto-eea-kitkat/commit/39a8899700b84a170ad255677289efacca3c4c3a)
+- Revert "Release volto-slate@5.1.0" [`b14761c`](https://github.com/eea/volto-eea-kitkat/commit/b14761c51e7acc132b95a91cf63a5ec7635154dc)
+- Release volto-slate@5.1.0 [`7c1c8b9`](https://github.com/eea/volto-eea-kitkat/commit/7c1c8b971c098682a04cb56f91b1cf85a119bd32)
+
+#### [4.1.4](https://github.com/eea/volto-eea-kitkat/compare/4.1.3...4.1.4)
+
+> 17 November 2021
+
+- Release [`#16`](https://github.com/eea/volto-eea-kitkat/pull/16)
+- Release @eeacms/volto-metadata-block@4.0.2 [`3afddfe`](https://github.com/eea/volto-eea-kitkat/commit/3afddfe665089559fc6921d0b70cc2fa5fb16b04)
+- Update docs about resolutions [`e0af879`](https://github.com/eea/volto-eea-kitkat/commit/e0af879d360c15aa10e471150f9cb2ce6f41b14a)
+- remove tests from master [`b4115c4`](https://github.com/eea/volto-eea-kitkat/commit/b4115c4f595d5767ad0493944ad132f3fdfcf445)
+- Revert "Disable cypress" [`a161c31`](https://github.com/eea/volto-eea-kitkat/commit/a161c31535cf33621c7513ddc5d8954ff9532c4a)
+
 #### [4.1.3](https://github.com/eea/volto-eea-kitkat/compare/4.1.2...4.1.3)
 
+> 15 November 2021
+
+- Enforce Volto add-ons pins with resolutions [`#14`](https://github.com/eea/volto-eea-kitkat/pull/14)
 - Disable cypress [`a406e2d`](https://github.com/eea/volto-eea-kitkat/commit/a406e2dc4be788f924642d43d82c677577a6877a)
 - Roll-back volto-slate to 4.2.1 [`ab6ae97`](https://github.com/eea/volto-eea-kitkat/commit/ab6ae97366c1b75b73d77636f5ab937401b9f8f7)
 - Add dependencies resolutions [`7ade630`](https://github.com/eea/volto-eea-kitkat/commit/7ade6305c9c9dfc5c2e332c50676d5f75ffe4c9f)

package/README.md

@@ -80,6 +80,27 @@
 
 1. Happy hacking!
 
+## Resolutions
+
+Volto EEA KitKat provides a set of generic Volto Add-ons and a `Known Good Set` of these add-ons versions to be used within your Volto projects without having to worry about which add-on version works best with another add-on. 
+
+While in other systems when you pin a package version to a specific number you will get that package version, in Javascript world [is not that simple](https://medium.com/swlh/welcome-to-dependency-hell-754a896f0440).
+
+For this, Volto EEA Kitkat is using [selective dependency resolutions](https://classic.yarnpkg.com/lang/en/docs/selective-version-resolutions/). While this work as expected in most of the cases, you may still have some surprises.
+
+### Troubleshooting
+
+1. Make sure your Volto project `yarn.lock` is not polluted. You can always reset your Volto project `yarn.lock` with:
+
+        $ npm install -g @plone/generator-volto
+        $ cd my-volto-project
+        $ yo @plone/volto --skip-install --no-interactive /tmp/new-volto-project
+        $ cp /tmp/new-volto-project/yarn.lock .
+        $ yarn
+
+2. Add-on `resolutions` don't work with `workspaces` (development mode), thus you'll need to define `resolutions` within Volto project. To tackle this issue, this Docker image automatically extracts `resolutions` from add-on and add them also to the Volto project before running tests.
+
+
 ### Try `volto-eea-kitkat` with Docker
 
 1. Get the latest Docker images

package/cypress.json

@@ -13,5 +13,9 @@
     "mochaFile": "cypress/reports/cypress-[hash].xml",
     "jenkinsMode": true,
     "toConsole": true
-  }
+  },
+  "integrationFolder": "../../../node_modules/@eeacms",
+  "testFiles": "**/cypress/integration/**/*.js",
+  "videoUploadOnPasses": false,
+  "screenshotOnRunFailure": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-kitkat",
-  "version": "4.1.3",
+  "version": "4.1.7",
   "description": "@eeacms/volto-eea-kitkat: Volto Add-ons bundle - A known good set of Volto addons to be used within all EEA projects and beyond",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -49,11 +49,11 @@
     "@eeacms/volto-block-image-cards"
   ],
   "dependencies": {
-    "@eeacms/volto-accordion-block": "3.4.7",
+    "@eeacms/volto-accordion-block": "3.4.8",
     "@eeacms/volto-banner": "1.0.1",
     "@eeacms/volto-block-divider": "2.1.3",
     "@eeacms/volto-block-image-cards": "0.1.4",
-    "@eeacms/volto-block-style": "3.5.2",
+    "@eeacms/volto-block-style": "3.5.3",
     "@eeacms/volto-block-toc": "2.2.2",
     "@eeacms/volto-columns-block": "4.4.6",
     "@eeacms/volto-corsproxy": "2.1.2",
@@ -61,7 +61,7 @@
     "@eeacms/volto-group-block": "4.3.1",
     "@eeacms/volto-listing-block": "0.1.2",
     "@eeacms/volto-matomo": "2.0.3",
-    "@eeacms/volto-metadata-block": "4.0.1",
+    "@eeacms/volto-metadata-block": "4.0.2",
     "@eeacms/volto-object-widget": "3.0.0",
     "@eeacms/volto-resize-helper": "0.2.5",
     "@eeacms/volto-sentry-rancher-config": "2.1.2",
@@ -77,11 +77,11 @@
     "volto-slate": "4.2.1"
   },
   "resolutions": {
-    "@eeacms/volto-accordion-block": "3.4.7",
+    "@eeacms/volto-accordion-block": "3.4.8",
     "@eeacms/volto-banner": "1.0.0",
     "@eeacms/volto-block-divider": "2.1.3",
     "@eeacms/volto-block-image-cards": "0.1.4",
-    "@eeacms/volto-block-style": "3.5.2",
+    "@eeacms/volto-block-style": "3.5.3",
     "@eeacms/volto-block-toc": "2.2.2",
     "@eeacms/volto-columns-block": "4.4.6",
     "@eeacms/volto-corsproxy": "2.1.2",
@@ -106,14 +106,15 @@
   },
   "devDependencies": {
     "@cypress/code-coverage": "^3.9.5",
-    "babel-plugin-transform-class-properties": "^6.24.1"
+    "babel-plugin-transform-class-properties": "^6.24.1",
+    "@plone/scripts": "*"
   },
   "scripts": {
     "release": "release-it",
     "bootstrap": "npm install -g ejs; npm link ejs; node bootstrap",
     "test": "make test",
     "test:fix": "make test-update",
-    "i18n": "rm -rf build/messages && NODE_ENV=production node src/i18n.js",
+    "i18n": "rm -rf build/messages && NODE_ENV=production i18n --addon",
     "pre-commit": "yarn stylelint:fix && yarn prettier:fix && yarn lint:fix",
     "stylelint": "if [ -d ./project ]; then ./project/node_modules/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'; else ../../../node_modules/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'; fi",
     "stylelint:overrides": "if [ -d ./project ]; then ./project/node_modules/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'; else ../../../node_modules/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'; fi",

package/src/i18n.js

@@ -1,180 +0,0 @@
-/* eslint no-console: 0 */
-/**
- * i18n script.
- * @module scripts/i18n
- */
-
-const { find, keys, map, concat, reduce } = require('lodash');
-const glob = require('glob').sync;
-const fs = require('fs');
-const Pofile = require('pofile');
-const babel = require('@babel/core');
-
-/**
- * Extract messages into separate JSON files
- * @function extractMessages
- * @return {undefined}
- */
-function extractMessages() {
-  map(glob('src/**/*.js?(x)'), (filename) => {
-    babel.transformFileSync(filename, {}, (err) => {
-      if (err) {
-        console.log(err);
-      }
-    });
-  });
-}
-
-/**
- * Get messages from separate JSON files
- * @function getMessages
- * @return {Object} Object with messages
- */
-function getMessages() {
-  return reduce(
-    concat(
-      {},
-      ...map(
-        // We ignore the existing customized shadowed components ones, since most
-        // probably we won't be overriding them
-        // If so, we should do it in the config object or somewhere else
-        glob('build/messages/src/**/*.json', {
-          ignore: 'build/messages/src/customizations/**',
-        }),
-        (filename) =>
-          map(JSON.parse(fs.readFileSync(filename, 'utf8')), (message) => ({
-            ...message,
-            filename: filename.match(/build\/messages\/src\/(.*).json$/)[1],
-          })),
-      ),
-    ),
-    (current, value) => {
-      let result = current;
-      if (current.id) {
-        result = {
-          [current.id]: {
-            defaultMessage: current.defaultMessage,
-            filenames: [current.filename],
-          },
-        };
-      }
-
-      if (result[value.id]) {
-        result[value.id].filenames.push(value.filename);
-      } else {
-        result[value.id] = {
-          defaultMessage: value.defaultMessage,
-          filenames: [value.filename],
-        };
-      }
-      return result;
-    },
-  );
-}
-
-/**
- * Convert messages to pot format
- * @function messagesToPot
- * @param {Object} messages Messages
- * @return {string} Formatted pot string
- */
-function messagesToPot(messages) {
-  return map(keys(messages).sort(), (key) =>
-    [
-      ...map(messages[key].filenames, (filename) => `#: ${filename}`),
-      `# defaultMessage: ${messages[key].defaultMessage}`,
-      `msgid "${key}"`,
-      'msgstr ""',
-    ].join('\n'),
-  ).join('\n\n');
-}
-
-/**
- * Pot header
- * @function potHeader
- * @return {string} Formatted pot header
- */
-function potHeader() {
-  return `msgid ""
-msgstr ""
-"Project-Id-Version: Plone\\n"
-"POT-Creation-Date: ${new Date().toISOString()}\\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"
-
-`;
-}
-
-/**
- * Format header
- * @function formatHeader
- * @param {Array} comments Array of comments
- * @param {Object} headers Object of header items
- * @return {string} Formatted header
- */
-function formatHeader(comments, headers) {
-  return [
-    ...map(comments, (comment) => `# ${comment}`),
-    'msgid ""',
-    'msgstr ""',
-    ...map(keys(headers), (key) => `"${key}: ${headers[key]}\\n"`),
-    '',
-  ].join('\n');
-}
-
-/**
- * Sync po by the pot file
- * @function syncPoByPot
- * @return {undefined}
- */
-function syncPoByPot() {
-  const pot = Pofile.parse(fs.readFileSync('locales/volto.pot', 'utf8'));
-
-  map(glob('locales/**/*.po'), (filename) => {
-    const po = Pofile.parse(fs.readFileSync(filename, 'utf8'));
-
-    fs.writeFileSync(
-      filename,
-      `${formatHeader(po.comments, po.headers)}
-${map(pot.items, (item) => {
-  const poItem = find(po.items, { msgid: item.msgid });
-  return [
-    `${map(item.references, (ref) => `#: ${ref}`).join('\n')}`,
-    `msgid "${item.msgid}"`,
-    `msgstr "${poItem ? poItem.msgstr : ''}"`,
-  ].join('\n');
-}).join('\n\n')}\n`,
-    );
-  });
-}
-
-// Main tasks
-console.log('Extracting messages from source files...');
-extractMessages();
-console.log('Synchronizing messages to pot file...');
-// We only write the pot file if it's really different
-const newPot = `${potHeader()}${messagesToPot(getMessages())}\n`.replace(
-  /"POT-Creation-Date:(.*)\\n"/,
-  '',
-);
-const oldPot = fs
-  .readFileSync('locales/volto.pot', 'utf8')
-  .replace(/"POT-Creation-Date:(.*)\\n"/, '');
-
-if (newPot !== oldPot) {
-  fs.writeFileSync(
-    'locales/volto.pot',
-    `${potHeader()}${messagesToPot(getMessages())}\n`,
-  );
-}
-console.log('Synchronizing messages to po files...');
-syncPoByPot();
-console.log('done!');