@eeacms/volto-eea-design-system 0.2.1

package/DEVELOP.md

@@ -0,0 +1,51 @@
+# volto-eea-design-system
+
+## Develop
+
+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`
+
+        npm install -g yo @plone/generator-volto mrs-developer
+
+1.  Create new volto app
+
+        yo @plone/volto my-volto-project --addon @eeacms/volto-eea-design-system --skip-install
+        cd my-volto-project
+
+1.  Add the following to `mrs.developer.json`:
+
+        {
+            "volto-eea-design-system": {
+                "url": "https://github.com/eea/volto-eea-design-system.git",
+                "package": "@eeacms/volto-eea-design-system",
+                "branch": "develop",
+                "path": "src"
+            }
+        }
+
+1.  Install
+
+        yarn develop
+        yarn
+
+1.  Start backend
+
+        docker pull plone
+        docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
+
+    ...wait for backend to setup and start - `Ready to handle requests`:
+
+        docker logs -f plone
+
+    ...you can also check http://localhost:8080/Plone
+
+1.  Start frontend
+
+        yarn start
+
+1.  Go to http://localhost:3000
+
+1.  Happy hacking!
+
+        cd src/addons/volto-eea-design-system/

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2020 European Environment Agency
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,196 @@
+# volto-eea-design-system
+
+[![Releases](https://img.shields.io/github/v/release/eea/volto-eea-design-system)](https://github.com/eea/volto-eea-design-system/releases)
+
+[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-eea-design-system%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-eea-design-system/job/master/display/redirect)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-master)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-master)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-master)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-master)
+
+[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-eea-design-system%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-eea-design-system/job/develop/display/redirect)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-develop)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-develop)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-develop)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-design-system-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-design-system-develop)
+
+
+[Volto](https://github.com/plone/volto) EEA Design System
+
+## Features
+
+This package provides the following features:
+
+1. A Semantic UI theme
+2. A repository for the design system source files and mockups
+3. A website to showcase the design system
+
+## Getting started
+
+### Try volto-eea-design-system with Docker
+
+1. Get the latest Docker images
+
+   ```
+   docker pull plone
+   docker pull plone/volto
+   ```
+
+2. Start Plone backend
+   ```
+   docker run -v $(pwd)/var:/data -e SITE=Plone -p 8080:8080 -e PROFILES="profile-plone.restapi:blocks" --name eea-plone -it --rm plone fg
+   ```
+3. Wait until you get the following message:
+
+   ```
+   Serving on http://0.0.0.0:8080
+   ```
+
+4. Start Volto frontend
+
+   ```
+   docker run -it --rm -p 3000:3000 --link eea-plone -e ADDONS="@eeacms/volto-eea-design-system" plone/volto
+   ```
+
+5. Wait until you get the following message:
+
+   ```
+   Volto started at http://localhost:8080
+   ```
+
+6. Go to http://localhost:3000, login with admin:admin if you need to edit the site.
+
+### Add volto-eea-design-system to your Volto project
+
+1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
+
+1. Start Volto frontend
+
+- If you already have a volto project, just update `package.json`:
+
+  ```JSON
+  "addons": [
+      "@eeacms/volto-eea-design-system"
+  ],
+
+  "dependencies": {
+      "@eeacms/volto-eea-design-system": "^1.0.0"
+  }
+  ```
+
+- If not, create one:
+
+  ```
+  npm install -g yo @plone/generator-volto
+  yo @plone/volto my-volto-project --addon @eeacms/volto-eea-design-system
+  cd my-volto-project
+  ```
+
+1. Install the new add-ons by updating `package.json` and restart Volto:
+
+   ```
+   yarn
+   yarn start
+   ```
+
+2. Go to http://localhost:3000
+
+3. Happy editing!
+
+### Try the design system website
+
+Checkout the docs found within the [website](https://github.com/eea/volto-eea-design-system/blob/develop/website/README.md) folder
+
+### Try the design system mockups
+
+Checkout the docs found within the [mockups](https://github.com/eea/volto-eea-design-system/blob/develop/mockups/README.md) folder
+
+## Release
+
+### Automatic release using Jenkins
+
+*  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.
+* It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits.
+* 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.
+* 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.
+* 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.
+* The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).
+* 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.
+* Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file.
+
+### Manual release from the develop branch ( beta release )
+
+#### Installation and configuration of release-it
+
+You need to first install the [release-it](https://github.com/release-it/release-it)  client.
+
+   ```
+   npm install -g release-it
+   ```
+
+Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository.
+
+Release-it is a tool that automates 4 important steps in the release process:
+
+1. Version increase in `package.json` ( increased from the current version in `package.json`)
+2. `CHANGELOG.md` automatic generation from commit messages ( grouped by releases )
+3. GitHub release on the commit with the changelog and package.json modification on the develop branch
+4. NPM release ( by default it's disabled, but can be enabled in the configuration file )
+
+To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens)
+
+   ```
+   export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX
+   ```
+
+ To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :
+
+   ```
+   echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc
+   ```
+
+#### Using release-it tool
+
+There are 3 yarn scripts that can be run to do the release
+
+##### yarn release-beta
+
+Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input).
+
+```
+? Select increment (next version):
+❯ prepatch (0.1.1-beta.0)
+  preminor (0.2.0-beta.0)
+  premajor (1.0.0-beta.0)
+  Other, please specify...
+```
+
+##### yarn release-major-beta
+
+Same as `yarn release-beta`, but with premajor version pre-selected.
+
+##### yarn release
+
+Generic command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other.
+
+#### Important notes
+
+> 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.
+
+> 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).
+
+
+## How to contribute
+
+See [DEVELOP.md](https://github.com/eea/volto-eea-design-system/blob/develop/DEVELOP.md).
+
+## Copyright and license
+
+The Initial Owner of the Original Code is European Environment Agency (EEA).
+All Rights Reserved.
+
+See [LICENSE.md](https://github.com/eea/volto-eea-design-system/blob/develop/LICENSE.md) for details.
+
+## Funding
+
+[European Environment Agency (EU)](http://eea.europa.eu)

package/bootstrap

@@ -0,0 +1,41 @@
+const path = require('path');
+const fs = require('fs');
+const ejs = require('ejs');
+
+const currentDir = path.basename(process.cwd());
+
+const bootstrap = function (ofile) {
+    fs.readFile(ofile, 'utf8', function (err, data) {
+        if (err) {
+            return console.log(err);
+        }
+        const result = ejs.render(data, {
+            addonName: `@eeacms/${currentDir}`,
+            name: currentDir
+        });
+        const output = ofile.replace('.tpl', '');
+        fs.writeFile(output, result, 'utf8', function (err) {
+            if (err) {
+                return console.log(err);
+            }
+        });
+        if (ofile.includes('.tpl')) {
+            fs.unlink(ofile, (err) => {
+                if (err) {
+                    return console.error(err);
+                }
+            });
+        }
+    });
+}
+
+fs.readdir(".", { withFileTypes: true }, (err, dirents) => {
+    const files = dirents
+        .filter(dirent => dirent.isFile())
+        .map(dirent => dirent.name);
+    files.forEach(function (file) {
+        if (file != 'bootstrap') {
+            bootstrap(file);
+        }
+    });
+});

package/cypress.json

@@ -0,0 +1,17 @@
+{
+  "baseUrl": "http://localhost:3000",
+  "viewportWidth": 1280,
+  "defaultCommandTimeout": 8888,
+  "chromeWebSecurity": false,
+  "reporter": "junit",
+  "video": true,
+  "retries": {
+    "runMode": 8,
+    "openMode": 0
+  },
+  "reporterOptions": {
+    "mochaFile": "cypress/reports/cypress-[hash].xml",
+    "jenkinsMode": true,
+    "toConsole": true
+  }
+}

package/jest-addon.config.js

@@ -0,0 +1,36 @@
+module.exports = {
+  testMatch: ['**/src/addons/**/?(*.)+(spec|test).[jt]s?(x)'],
+  collectCoverageFrom: [
+    'src/addons/**/src/**/*.{js,jsx,ts,tsx}',
+    '!src/**/*.d.ts',
+  ],
+  moduleNameMapper: {
+    '@plone/volto/cypress': '<rootDir>/node_modules/@plone/volto/cypress',
+    '@plone/volto/babel': '<rootDir>/node_modules/@plone/volto/babel',
+    '@plone/volto/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
+    '@package/(.*)$': '<rootDir>/src/$1',
+    '@plone/volto-quanta/(.*)$': '<rootDir>/src/addons/volto-quanta/src/$1',
+    '@eeacms/(.*?)/(.*)$': '<rootDir>/src/addons/$1/src/$2',
+    'volto-slate/(.*)$': '<rootDir>/src/addons/volto-slate/src/$1',
+    '~/(.*)$': '<rootDir>/src/$1',
+    'load-volto-addons':
+      '<rootDir>/node_modules/@plone/volto/jest-addons-loader.js',
+  },
+  transform: {
+    '^.+\\.js(x)?$': 'babel-jest',
+    '^.+\\.css$': 'jest-css-modules',
+    '^.+\\.less$': 'jest-css-modules',
+    '^.+\\.scss$': 'jest-css-modules',
+    '^.+\\.(png)$': 'jest-file',
+    '^.+\\.(jpg)$': 'jest-file',
+    '^.+\\.(svg)$': './node_modules/@plone/volto/jest-svgsystem-transform.js',
+  },
+  coverageThreshold: {
+    global: {
+      branches: 5,
+      functions: 5,
+      lines: 5,
+      statements: 5,
+    },
+  },
+};

package/mockups/README.md

@@ -0,0 +1 @@
+### EEA Design mockups

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@eeacms/volto-eea-design-system",
+  "version": "0.2.1",
+  "description": "@eeacms/volto-eea-design-system: Volto add-on",
+  "main": "src/index.js",
+  "author": "European Environment Agency: IDM2 A-Team",
+  "license": "MIT",
+  "homepage": "https://github.com/eea/volto-eea-design-system",
+  "keywords": [
+    "volto-addon",
+    "volto",
+    "plone",
+    "react"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:eea/volto-eea-design-system.git"
+  },
+  "addons": [
+    "@eeacms/volto-corsproxy"
+  ],
+  "dependencies": {
+    "@eeacms/volto-corsproxy": "*",
+    "remixicon": "2.5.0"
+  },
+  "devDependencies": {
+    "@cypress/code-coverage": "^3.9.5",
+    "babel-plugin-transform-class-properties": "^6.24.1"
+  },
+  "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",
+    "i18n": "rm -rf build/messages && NODE_ENV=production node src/i18n.js",
+    "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  --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}'; fi",
+    "cypress:run": "../../../node_modules/cypress/bin/cypress run",
+    "cypress:open": "../../../node_modules/cypress/bin/cypress open"
+  }
+}

package/razzle.extend.js

@@ -0,0 +1,23 @@
+const path = require('path');
+const plugins = (defaultPlugins) => {
+  return defaultPlugins;
+};
+const modify = (config, { target, dev }, webpack) => {
+  const themeConfigPath = `${__dirname}/theme/theme.config`;
+  config.resolve.alias['../../theme.config$'] = themeConfigPath;
+  config.resolve.alias['../../theme.config'] = themeConfigPath;
+
+  const projectRootPath = path.resolve('.');
+  const themesPath = `${projectRootPath}/node_modules/@eeacms/volto-eea-design-system/theme/themes`;
+
+  config.resolve.alias['eea-volto-themes'] = themesPath;
+  config.resolve.alias['ui-theme'] = `${themesPath}/eea/`;
+  config.resolve.alias['ui-assets'] = `${themesPath}/eea/assets`;
+
+  return config;
+};
+
+module.exports = {
+  plugins,
+  modify,
+};

package/src/helpers/index.js

@@ -0,0 +1,2 @@
+export useClickOutside from './useClickOutside';
+export usePrevious from './usePrevious';

package/src/helpers/useClickOutside.js

@@ -0,0 +1,30 @@
+import React from 'react';
+import { doesNodeContainClick } from 'semantic-ui-react/dist/commonjs/lib';
+
+/**
+ * Call the callback when a click happens outside the targetRefs elements
+ */
+export default function useClickOutside({ targetRefs = [], callback }) {
+  const handleClickOutside = React.useCallback(
+    (e) => {
+      const isInsideTarget =
+        targetRefs.findIndex(
+          (nodeRef) =>
+            nodeRef.current && doesNodeContainClick(nodeRef.current, e),
+        ) > -1;
+
+      if (isInsideTarget) return;
+      callback();
+    },
+    [callback, targetRefs],
+  );
+
+  React.useLayoutEffect(() => {
+    document.addEventListener('mousedown', handleClickOutside, false);
+    return () => {
+      document.removeEventListener('mousedown', handleClickOutside, false);
+    };
+  }, [handleClickOutside]);
+
+  return null;
+}

package/src/helpers/usePrevious.js

@@ -0,0 +1,9 @@
+import React from 'react';
+
+export default function usePrevious(value) {
+  const ref = React.useRef();
+  React.useEffect(() => {
+    ref.current = value;
+  });
+  return ref.current;
+}

package/src/i18n.js

@@ -0,0 +1,180 @@
+/* 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!');

package/src/index.js

@@ -0,0 +1,6 @@
+const applyConfig = (config) => {
+  config.settings.navDepth = 3;
+  return config;
+};
+
+export default applyConfig;