Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vite: Pass remixUserConfig to preset config hook #8797

Merged
merged 1 commit into from
Feb 20, 2024

Conversation

markdalgleish
Copy link
Member

This change allows presets to configure Remix differently based on the user config.

The use case driving this change is to allow Vercel to avoid setting serverBundles when consumers have enabled SPA mode, otherwise Vercel preset consumers get the following warning and there's no way to avoid it:

⚠️ SPA Mode: the serverBundles config is invalid with unstable_ssr:false and will be ignored

Copy link

changeset-bot bot commented Feb 20, 2024

🦋 Changeset detected

Latest commit: e49565e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 16 packages
Name Type
@remix-run/dev Patch
create-remix Patch
remix Patch
@remix-run/architect Patch
@remix-run/cloudflare Patch
@remix-run/cloudflare-pages Patch
@remix-run/cloudflare-workers Patch
@remix-run/css-bundle Patch
@remix-run/deno Patch
@remix-run/eslint-config Patch
@remix-run/express Patch
@remix-run/node Patch
@remix-run/react Patch
@remix-run/serve Patch
@remix-run/server-runtime Patch
@remix-run/testing Patch

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

@@ -527,6 +529,9 @@ let deepFreeze = (o: any) => {

export type RemixVitePlugin = (config?: VitePluginConfig) => Vite.Plugin[];
export const remixVitePlugin: RemixVitePlugin = (remixUserConfig = {}) => {
// Prevent mutations to the user config
remixUserConfig = deepFreeze(remixUserConfig);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured it's safest to freeze the user config up front rather than delaying it.

@@ -46,16 +77,20 @@ const files = {
}),
},

// Ensure remixConfig is called with a frozen Remix user config
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good thing we had a test for a frozen resolved config object. It prompted me to add this behaviour here too.

@markdalgleish markdalgleish merged commit 85d988f into release-next Feb 20, 2024
9 checks passed
@markdalgleish markdalgleish deleted the markdalgleish/preset-remix-user-config branch February 20, 2024 00:45
Copy link
Contributor

🤖 Hello there,

We just published version 2.7.0-pre.3 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

Copy link
Contributor

🤖 Hello there,

We just published version 2.7.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants