Fork razzle into @plone/razzle (#7542)

Co-authored-by: Steve Piercy <[email protected]>
Co-authored-by: Víctor Fernández de Alba <[email protected]>
Co-authored-by: Bhanudas Hegaje <[email protected]>

Author: 4 people

apps/rr7/README.md

@@ -27,4 +27,4 @@ make backend-docker-start
 
 ## About this app
 
-- [Remix Docs](https://remix.run/docs/en/main)
+- [Remix Docs](https://reactrouter.com/start/framework/installation)

docs/source/development/add-ons/index.md

@@ -19,6 +19,7 @@ load-add-on-configuration
 create-an-add-on-18
 create-an-add-on-17
 theme-add-on
+test-add-ons-19
 test-add-ons-18
 test-add-ons-17
 extend-webpack-add-on

docs/source/development/add-ons/test-add-ons-18.md

@@ -99,13 +99,6 @@ The following code is boilerplate setup for Vitest.
 
 ```javascript
 import '@testing-library/jest-dom';
-import { expect, describe, it, vi } from 'vitest';
-
-// Make Vitest globals available throughout the test suite
-global.describe = describe;
-global.it = it;
-global.expect = expect;
-global.vi = vi;
 
 // Stub the global fetch API to prevent actual network requests in tests
 vi.stubGlobal('fetch', vi.fn(() =>

docs/source/development/add-ons/test-add-ons-19.md

@@ -0,0 +1,15 @@
+---
+myst:
+  html_meta:
+    "description": "Test add-ons in Volto 19"
+    "property=og:description": "Test add-ons in Volto 19"
+    "property=og:title": "Test add-ons in Volto 19"
+    "keywords": "Volto, Plone, testing, test, CI, add-ons, Vitest, Jest"
+---
+
+# Test add-ons in Volto 19
+
+In Volto 19, Jest has been completely removed, and add-ons that rely on Jest-based test suites are no longer supported.
+You must migrate your add-on tests to Vitest.
+
+See the guide {doc}`test-add-ons-18` for how to migrate your add-on tests from Jest to Vitest.

docs/source/upgrade-guide/index.md

@@ -48,6 +48,38 @@ You should take the following actions for your Volto 19 projects.
 
 If you can't upgrade immediately, you may continue to run Volto 19 on Node.js 20 at your own risk, but be aware that issues specific to Node.js 20 will not be fixed in the Volto core CI or releases.
 
+(replace-razzle-with-volto-razzle)=
+
+### Replace `razzle` with `@volto/razzle` (fork)
+```{versionchanged} Volto 19.0.0-alpha.14
+```
+
+`@volto/razzle` is a fork of the upstream `razzle` package that contains Volto-specific fixes and patches.
+Use `@volto/razzle` in your Volto 19 projects when either you need the Volto-compatible build behavior, or the Volto team provides temporary patches that are not yet merged upstream in Razzle.
+
+For most projects, no action is required.
+The fork maintains full compatibility with the original `razzle` package, preserving all CLI entry points such as `razzle start`, `razzle build`, and `razzle test`.
+
+However, if you have customized Volto's internals in your project—for example, by importing internal modules directly from the `razzle` package such as `require('razzle/some/path')`—then you need to update those imports to reference `@volto/razzle` instead.
+
+To verify whether your project requires updates, search for any direct references to internal `razzle` modules:
+
+```shell
+grep -R "require.*razzle/" -n --exclude-dir=node_modules || true
+grep -R "from.*razzle/" -n --exclude-dir=node_modules || true
+```
+
+If you find any matches, check in particular:
+
+-   build and Babel configurations, including {file}`babel.config.js`, {file}`.babelrc`, {file}`webpack.config.js`, and {file}`razzle.config.js`
+-   any presets or plugins sections that import internal `razzle` modules
+-   custom build scripts that reference `razzle` internals
+
+```{note}
+The fork exists so we can ship fixes and compatibility patches required by Volto, since the upstream is no longer maintained.
+Our goal is to keep `@volto/razzle` compatible with the `razzle` public API.
+```
+
 ### `pnpm` has been upgraded to version 10
 ```{versionchanged} Volto 19.0.0-alpha.7
 ```

package.json

@@ -19,7 +19,7 @@
     "start:project": "pnpm --filter plone run start",
     "lint": "make build-all-deps && eslint --max-warnings=0 '{apps,packages}/**/*.{js,jsx,ts,tsx}'",
     "lint:volto": "pnpm --filter @plone/volto run lint",
-    "test": "pnpm --filter @plone/volto run vitest",
+    "test": "pnpm --filter @plone/volto run test",
     "test:ci": "pnpm --filter @plone/volto run test:ci",
     "i18n": "pnpm --filter @plone/volto run i18n",
     "i18n:ci": "pnpm --filter @plone/volto i18n:ci",
@@ -45,12 +45,7 @@
   "packageManager": "[email protected]",
   "pnpm": {
     "overrides": {
-      "@pmmmwh/react-refresh-webpack-plugin": "0.5.11",
-      "immer@8": "10.1.3",
-      "react-refresh": "0.14.0"
-    },
-    "patchedDependencies": {
-      "[email protected]": "patches/[email protected]"
+      "immer@8": "10.1.3"
     },
     "ignoredBuiltDependencies": [
       "@parcel/watcher"

packages/scripts/news/7619.breaking

@@ -0,0 +1 @@
+Fork `babel-razzle-preset` from Razzle. Update dependencies. @sneridagh

packages/scripts/package.json

@@ -42,7 +42,7 @@
   "dependencies": {
     "@babel/core": "^7.0.0",
     "babel-plugin-react-intl": "5.1.17",
-    "babel-preset-razzle": "4.2.17",
+    "@plone/babel-preset-razzle": "workspace:^",
     "chalk": "4",
     "commander": "8.2.0",
     "comment-json": "^4.2.3",

packages/volto-babel-preset-razzle/.release-it.json

@@ -0,0 +1,29 @@
+{
+  "plugins": {
+    "../scripts/prepublish.js": {}
+  },
+  "hooks": {
+    "after:bump": [
+      "pipx run towncrier build --draft --yes --version ${version} > .changelog.draft",
+      "pipx run towncrier build --yes --version ${version}"
+    ],
+    "after:release": "rm .changelog.draft"
+  },
+  "npm": {
+    "publish": false
+  },
+  "git": {
+    "commitArgs": ["--no-verify"],
+    "changelog": "pipx run towncrier build --draft --yes --version 0.0.0",
+    "requireUpstream": false,
+    "requireCleanWorkingDir": false,
+    "commitMessage": "Release @plone/babel-preset-razzle ${version}",
+    "tagName": "plone-slate-${version}",
+    "tagAnnotation": "Release @plone/babel-preset-razzle ${version}"
+  },
+  "github": {
+    "release": true,
+    "releaseName": "@plone/babel-preset-razzle ${version}",
+    "releaseNotes": "cat .changelog.draft"
+  }
+}

packages/volto-babel-preset-razzle/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @plone/babel-preset-razzle Release Notes
+
+<!-- Do *NOT* add new change log entries to this file.
+     Instead create a file in the news directory.
+     For helpful instructions, see:
+     https://6.docs.plone.org/contributing/index.html#change-log-entry
+-->
+
+<!-- towncrier release notes start -->