Rename constants/Language module to the right suffix, and other act…

…ions to make ESM bundlers happy. (#6130) Co-authored-by: Steve Piercy <web@stevepiercy.com>
plone · Jun 28, 2024 · 502c0f7 · 502c0f7
1 parent 5144d2d
commit 502c0f7
Show file tree

Hide file tree

Showing 13 changed files with 52 additions and 6 deletions.
diff --git a/docs/source/upgrade-guide/index.md b/docs/source/upgrade-guide/index.md
@@ -354,6 +354,23 @@ The input field's placeholder text was moved above the buttons.
 Together these changes improve usability both on small screens and in small containers, such as when the widget is in grid block elements.
 
 
+### Renamed the `constants/Languages` module
+
+`src/constants/Languages.js` has been renamed to `src/constants/Languages.cjs` since, in fact, it's a CommonJS module.
+This change is needed for consistency with module suffixes in Volto core, in preparation for replacing Razzle with a modern builder.
+
+The only Volto component that makes use of it is `PersonalPreferences`.
+If you shadow it, then you should update this component.
+For the rest, it is unlikely that your code refers to this module, since it's used internally by Volto itself.
+
+### Renamed `test-setup-config` module
+
+`test-setup-config.js` has been renamed to `test-setup-config.jsx` since, in fact, it contains JSX.
+This change is needed for consistency with module suffixes in Volto core, in preparation for replacing Razzle with a modern builder.
+
+It is unlikely that your code uses it, unless you heavily customized the Jest testing pipeline.
+
+
 (volto-upgrade-guide-17.x.x)=
 
 ## Upgrading to Volto 17.x.x

diff --git a/packages/volto-slate/news/6130.internal b/packages/volto-slate/news/6130.internal
@@ -0,0 +1 @@
+Add proper dependencies to `volto-slate`. @sneridagh
diff --git a/packages/volto-slate/package.json b/packages/volto-slate/package.json
@@ -18,16 +18,22 @@
     "access": "public"
   },
   "dependencies": {
+    "classnames": "2.2.6",
+    "github-slugger": "1.4.0",
     "image-extensions": "1.1.0",
+    "is-hotkey": "0.2.0",
     "is-url": "1.2.4",
     "jsdom": "^16.6.0",
+    "lodash": "4.17.21",
     "react": "18.2.0",
-    "react-intersection-observer": "9.1.0",
     "react-dom": "18.2.0",
+    "react-intersection-observer": "9.1.0",
+    "redux-mock-store": "1.5.4",
     "slate": "0.100.0",
     "slate-history": "0.100.0",
     "slate-hyperscript": "0.100.0",
     "slate-react": "0.98.4",
+    "uuid": "^9.0.1",
     "weak-key": "^1.0.2"
   },
   "devDependencies": {

diff --git a/packages/volto/news/6130.internal b/packages/volto/news/6130.internal
@@ -0,0 +1 @@
+Renamed `constants/Languages.js` to `constants/Languages.cjs` @sneridagh
diff --git a/packages/volto/package.json b/packages/volto/package.json
@@ -108,7 +108,7 @@
     },
     "setupFiles": [
       "./test-setup-globals.js",
-      "./test-setup-config.js"
+      "./test-setup-config.jsx"
     ],
     "globalSetup": "./global-test-setup.js",
     "setupFilesAfterEnv": [

diff --git a/packages/volto/razzle.config.js b/packages/volto/razzle.config.js
@@ -20,7 +20,7 @@ const AfterBuildPlugin = require('@fiverr/afterbuild-webpack-plugin');
 const fileLoaderFinder = makeLoaderFinder('file-loader');
 
 const projectRootPath = path.resolve('.');
-const languages = require('./src/constants/Languages');
+const languages = require('./src/constants/Languages.cjs');
 
 const packageJson = require(path.join(projectRootPath, 'package.json'));
 

diff --git a/packages/volto/src/components/manage/Preferences/PersonalPreferences.jsx b/packages/volto/src/components/manage/Preferences/PersonalPreferences.jsx
@@ -14,7 +14,7 @@ import { toast } from 'react-toastify';
 
 import { Toast } from '@plone/volto/components';
 import { Form } from '@plone/volto/components/manage/Form';
-import languages from '@plone/volto/constants/Languages';
+import languages from '@plone/volto/constants/Languages.cjs';
 import { changeLanguage } from '@plone/volto/actions';
 import { toGettextLang } from '@plone/volto/helpers';
 import config from '@plone/volto/registry';

diff --git a/packages/volto/src/constants/Languages.js → packages/volto/src/constants/Languages.cjs b/packages/volto/src/constants/Languages.js → packages/volto/src/constants/Languages.cjs
@@ -20,3 +20,5 @@ module.exports = {
   pt_BR: 'Português (Brasil)',
   zh_CN: '中文',
 };
+
+// export default languages;
diff --git a/packages/volto/src/helpers/AuthToken/AuthToken.js b/packages/volto/src/helpers/AuthToken/AuthToken.js
@@ -102,7 +102,7 @@ export function persistAuthToken(store, req) {
   handleChange(true);
 }
 
-if (module.hot) {
+if (module?.hot) {
   module.hot.dispose((data) => {
     data.reloaded = true;
   });

diff --git a/packages/volto/src/server.jsx b/packages/volto/src/server.jsx
@@ -36,7 +36,7 @@ import userSession from '@plone/volto/reducers/userSession/userSession';
 
 import ErrorPage from '@plone/volto/error';
 
-import languages from '@plone/volto/constants/Languages';
+import languages from '@plone/volto/constants/Languages.cjs';
 
 import configureStore from '@plone/volto/store';
 import { ReduxAsyncConnect, loadOnServer } from './helpers/AsyncConnect';

diff --git a/packages/volto/test-setup-config.js → packages/volto/test-setup-config.jsx b/packages/volto/test-setup-config.js → packages/volto/test-setup-config.jsx
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/styles/Vocab/Plone/accept.txt b/styles/Vocab/Plone/accept.txt
@@ -4,6 +4,7 @@
 `plone.volto`
 [Aa]sync
 [Bb]ackend
+CommonJS
 JavaScript
 npm
 nvm