fix: kit compatibility (#546)

dominikg · web-flow · commit 47c54c92b886 · 2022-12-12T10:22:17.000+01:00
* chore: update to latest kit and adapter versions

* fix: update sveltekit detection in inspector

* refactor: move isSvelteKit to ResolvedOptions

* fix: watch svelte.config.js and restart for sveltekit

* revert: remove special handling for sveltekit svelte.config.js change and testcase. This is now the responsibility of kit

* refactor: move sveltekit detection to inspector plugin

* fix: remove scan check
diff --git a/.changeset/witty-pandas-whisper.md b/.changeset/witty-pandas-whisper.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/vite-plugin-svelte': patch
+---
+
+improve detection of sveltekit in inspector plugin to be compatible to latest changes
diff --git a/packages/e2e-tests/inspector-kit/package.json b/packages/e2e-tests/inspector-kit/package.json
@@ -9,7 +9,7 @@
     "preview": "vite preview"
   },
   "devDependencies": {
-    "@sveltejs/kit": "^1.0.0-next.572",
+    "@sveltejs/kit": "^1.0.0-next.582",
     "svelte": "^3.54.0",
     "vite": "^4.0.0"
   },
diff --git a/packages/e2e-tests/inspector-kit/src/app.html b/packages/e2e-tests/inspector-kit/src/app.html
@@ -3,6 +3,7 @@
 	<head>
 		<meta charset="utf-8" />
 		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<link rel="icon" href="/favicon.png" />
 		%sveltekit.head%
 	</head>
 	<body>
diff --git a/packages/e2e-tests/inspector-kit/static/favicon.png b/packages/e2e-tests/inspector-kit/static/favicon.png
diff --git a/packages/e2e-tests/kit-node/__tests__/kit.spec.ts b/packages/e2e-tests/kit-node/__tests__/kit.spec.ts
@@ -243,17 +243,6 @@ describe('kit-node', () => {
 						expect(await getText('button')).toBe('Clicks: 0');
 					});
 				});
-				describe('config file update', () => {
-					it('should auto refresh', async () => {
-						const button = await getEl('button');
-						await button.click();
-						expect(await getText('button')).toBe('Clicks: 1');
-						editFile('svelte.config.js', (config) => config + '\n');
-						await waitForNavigation({ waitUntil: 'networkidle' });
-						// clicks should reset, means the browser refreshed
-						expect(await getText('button')).toBe('Clicks: 0');
-					});
-				});
 			});
 		}
 	});
diff --git a/packages/e2e-tests/kit-node/package.json b/packages/e2e-tests/kit-node/package.json
@@ -11,8 +11,8 @@
     "check:watch": "svelte-check --tsconfig ./jsconfig.json --watch"
   },
   "devDependencies": {
-    "@sveltejs/adapter-node": "^1.0.0-next.102",
-    "@sveltejs/kit": "^1.0.0-next.572",
+    "@sveltejs/adapter-node": "^1.0.0-next.104",
+    "@sveltejs/kit": "^1.0.0-next.582",
     "e2e-test-dep-svelte-api-only": "file:../_test_dependencies/svelte-api-only",
     "e2e-test-dep-vite-plugins": "file:../_test_dependencies/vite-plugins",
     "svelte": "^3.54.0",
diff --git a/packages/playground/big-component-library-kit/package.json b/packages/playground/big-component-library-kit/package.json
@@ -11,7 +11,7 @@
 	},
 	"devDependencies": {
 		"@sveltejs/adapter-auto": "1.0.0-next.90",
-		"@sveltejs/kit": "^1.0.0-next.572",
+		"@sveltejs/kit": "^1.0.0-next.582",
 		"carbon-components-svelte": "^0.70.12",
 		"carbon-icons-svelte": "^11.4.0",
 		"carbon-preprocess-svelte": "^0.9.1",
diff --git a/packages/playground/kit-demo-app/package.json b/packages/playground/kit-demo-app/package.json
@@ -13,7 +13,7 @@
 		"@fontsource/fira-mono": "^4.5.10",
 		"@neoconfetti/svelte": "^1.0.0",
 		"@sveltejs/adapter-auto": "^1.0.0-next.90",
-		"@sveltejs/kit": "^1.0.0-next.572",
+		"@sveltejs/kit": "^1.0.0-next.582",
 		"@types/cookie": "^0.5.1",
 		"svelte": "^3.54.0",
 		"svelte-check": "^2.10.1",
diff --git a/packages/vite-plugin-svelte/src/ui/inspector/plugin.ts b/packages/vite-plugin-svelte/src/ui/inspector/plugin.ts
@@ -35,22 +35,23 @@ export function svelteInspector(): Plugin {
 
 		configResolved(config) {
 			const vps = config.plugins.find((p) => p.name === 'vite-plugin-svelte');
-			if (vps?.api?.options?.experimental?.inspector) {
-				inspectorOptions = {
-					...defaultInspectorOptions,
-					...vps.api.options.experimental.inspector
-				};
-			}
-			if (!vps || !inspectorOptions) {
+			const options = vps?.api?.options?.experimental?.inspector;
+			if (!vps || !options) {
 				log.debug('inspector disabled, could not find config');
 				disabled = true;
-			} else {
-				if (vps.api.options.kit && !inspectorOptions.appendTo) {
-					const out_dir = path.basename(vps.api.options.kit.outDir || '.svelte-kit');
-					inspectorOptions.appendTo = `${out_dir}/generated/root.svelte`;
-				}
-				appendTo = inspectorOptions.appendTo;
+				return;
+			}
+			inspectorOptions = {
+				...defaultInspectorOptions,
+				...options
+			};
+			const isSvelteKit = config.plugins.some((p) => p.name.startsWith('vite-plugin-sveltekit'));
+			if (isSvelteKit && !inspectorOptions.appendTo) {
+				// this could append twice if a user had a file that ends with /generated/root.svelte
+				// but that should be rare and inspector doesn't execute twice
+				inspectorOptions.appendTo = `/generated/root.svelte`;
 			}
+			appendTo = inspectorOptions.appendTo;
 		},
 
 		async resolveId(importee: string, importer, options) {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@sveltejs/vite-plugin-svelte': patch
 +---
++
 +improve detection of sveltekit in inspector plugin to be compatible to latest changes