fix: pre-bundle lowlight and highlight.js for inline Portable Text editor hydration - #2921
Merged
Conversation
…itor hydration EmDash-Run: 7361befc-9ace-4078-82fe-22c6d12f5f63
🦋 Changeset detectedLatest commit: 226f3aa The changes in this PR will be included in the next version bump. This PR includes changesets to release 17 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://bot-fix-2916.try.emdashcms.com, https://bot-fix-2916-emdash-playground.emdash-cms.workers.dev (commit 226f3aa)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
@emdash-cms/admin
@emdash-cms/auth
@emdash-cms/auth-atproto
@emdash-cms/blocks
@emdash-cms/cloudflare
@emdash-cms/contentful-to-portable-text
emdash
create-emdash
@emdash-cms/gutenberg-to-portable-text
@emdash-cms/plugin-cli
@emdash-cms/plugin-types
@emdash-cms/registry-client
@emdash-cms/registry-lexicons
@emdash-cms/registry-moderation
@emdash-cms/registry-verification
@emdash-cms/sandbox-workerd
@emdash-cms/x402
@emdash-cms/plugin-ai-moderation
@emdash-cms/plugin-atproto
@emdash-cms/plugin-audit-log
@emdash-cms/plugin-color
@emdash-cms/plugin-embeds
@emdash-cms/plugin-field-kit
@emdash-cms/plugin-forms
@emdash-cms/plugin-webhook-notifier
commit: |
17 tasks
ascorbic
marked this pull request as ready for review
September 6, 2026 06:20
ascorbic
requested changes
Sep 6, 2026
Comment on lines
+578
to
+583
| // The inline Portable Text editor loads the code-block extension, which | ||
| // pulls in lowlight. lowlight default-imports highlight.js/lib/core, a | ||
| // CommonJS file. Pre-bundling both here ensures Vite wraps the deep CJS | ||
| // import with an ESM interop stub instead of serving it raw to the | ||
| // browser, which would make hydration fail with | ||
| // "does not provide an export named 'default'". |
Collaborator
There was a problem hiding this comment.
We don't need all these comments
| } | ||
| }); | ||
|
|
||
| describe("createViteConfig inline Portable Text hydration deps", () => { |
Collaborator
There was a problem hiding this comment.
This is a shallow test. Include an e2e test proving that the PT editor shows up in the visual editor
…ine PT editor hydration EmDash-Run: 9eaa4754-5b05-4f1f-96ed-e2349350c3f2
ascorbic
approved these changes
Sep 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds
lowlight,highlight.js, andhighlight.js/lib/coreto the clientoptimizeDeps.includelist so Vite pre-bundles the CommonJShighlight.js/lib/coreentry with ESM interop. This fixes the inline Portable Text editor hydration failure in dev mode that caused rendered content to disappear when visual editing is enabled.packages/core/tests/unit/astro/vite-config.test.tsemdashpnpm typecheck,pnpm lint:json,pnpm format --check, focusedvitestsuite all passCloses #2916.
A candidate change the reporter confirmed against their own site via the preview build:
Opened automatically by emdashbot as a draft. A maintainer must review before merge.
Type of change
Checklist
pnpm typecheckpassespnpm lintpassespnpm testpasses (or targeted tests for my change)pnpm formathas been runmessages.pochanges except in translation PRs — a workflow extracts catalogs on merge tomain.AI-generated code disclosure
Screenshots / test output