Skip to content

fix: optimize "svelte > clsx" by default #1124

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jun 3, 2025
Merged

fix: optimize "svelte > clsx" by default #1124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84686b3
fix: optimize svelte > clsx by default
dominikg May 30, 2025
1c4cb7e
chore: add comment to explain use of runtime deps
dominikg Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fine-nights-mix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sveltejs/vite-plugin-svelte': patch
---

add `svelte > clsx` to optimizeDeps.include to avoid page reload when using vite6 and npm
1 change: 1 addition & 0 deletions packages/e2e-tests/kit-node/__tests__/kit.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,7 @@ describe('kit-node', () => {
'svelte/store',
'svelte/transition',
'svelte',
'svelte > clsx',
'svelte/internal/disclose-version',
'svelte/internal/flags/legacy',
'svelte/internal/flags/tracing',
Expand Down
2 changes: 2 additions & 0 deletions packages/e2e-tests/prebundle-svelte-deps/__tests__/prebundle-svelte-deps.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ if (!isBuild) {
expect(optimizedPaths).toContain('e2e-test-dep-svelte-api-only');
expect(optimizedPaths).toContain('e2e-test-dep-svelte-nested');
expect(optimizedPaths).toContain('e2e-test-dep-svelte-module');
expect(optimizedPaths).toContain('svelte');
expect(optimizedPaths).toContain('svelte > clsx');
});

test('should not optimize excluded svelte dependencies', () => {
Expand Down
11 changes: 8 additions & 3 deletions packages/vite-plugin-svelte/src/utils/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
import { createRequire } from 'node:module';

export const SVELTE_IMPORTS = Object.entries(
createRequire(import.meta.url)('svelte/package.json').exports
)
const sveltePkg = createRequire(import.meta.url)('svelte/package.json');

// list of svelte runtime dependencies to optimize together with svelte itself
export const SVELTE_RUNTIME_DEPENDENCIES = [
'clsx' // avoids dev server restart after page load with npm + vite6 (see #1067)
].filter((dep) => !!sveltePkg.dependencies?.[dep]);

export const SVELTE_IMPORTS = Object.entries(sveltePkg.exports)
.map(([name, config]) => {
// ignore type only
if (typeof config === 'object' && Object.keys(config).length === 1 && config.types) {
Expand Down
6 changes: 4 additions & 2 deletions packages/vite-plugin-svelte/src/utils/options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ import {
DEFAULT_SVELTE_EXT,
FAQ_LINK_MISSING_EXPORTS_CONDITION,
SVELTE_EXPORT_CONDITIONS,
SVELTE_IMPORTS
SVELTE_IMPORTS,
SVELTE_RUNTIME_DEPENDENCIES
} from './constants.js';

import path from 'node:path';
Expand Down Expand Up @@ -550,8 +551,9 @@ function buildExtraConfigForSvelte(config) {
const svelteImportsToInclude = SVELTE_IMPORTS.filter(
(si) => !(si.endsWith('/server') || si.includes('/server/'))
);
svelteImportsToInclude.push(...SVELTE_RUNTIME_DEPENDENCIES.map((dep) => `svelte > ${dep}`));
log.debug(
`adding bare svelte packages to optimizeDeps.include: ${svelteImportsToInclude.join(', ')} `,
`adding bare svelte packages and runtime dependencies to optimizeDeps.include: ${svelteImportsToInclude.join(', ')} `,
undefined,
'config'
);
Expand Down