feat: restart server when svelte config file changes (fixes #63) (#72)

* feat: restart server when svelte config file changes (fixes #63)

* fix: make sure the absolute path of the loaded svelte config file is kept in resolvedOptions

* refactor: use package.json scripts and execa to start servers for e2e-tests; add tests for svelte config watching

* fix: remove syntax not supported by node12 from e2e script

* fix: use writeFileSync instead of fs/promises for node12

* chore: remove debugging screenshots

* chore: update dependencies

* test: move to lower portrange and archive dist on failure

* test: fix e2e-server script. correct error output and don't throw if closing server wasn't graceful

* fix: really bad c&p err

* test: increase sleep time on windows to account for slower devserver restart

* fix invalid doc

* chore: update changeset

Author: dominikg

.changeset/large-ears-press.md

@@ -0,0 +1,7 @@
+---
+'@sveltejs/vite-plugin-svelte': minor
+---
+
+- Restart dev server when svelte config file changes
+- Refactored e2e-tests to use package.json scripts
+- Updated dependencies

.github/workflows/ci.yml

@@ -168,7 +168,7 @@ jobs:
       - name: archive tests temp directory
         if: failure()
         shell: bash
-        run: tar -cvf test-temp.tar  --exclude="node_modules" --exclude=".yarn" --exclude="dist" --exclude=".pnp.js" temp/
+        run: tar -cvf test-temp.tar  --exclude="node_modules"  temp/
       - uses: actions/upload-artifact@v2
         if: failure()
         with:

package.json

@@ -7,9 +7,9 @@
     "build": "pnpm --dir packages/vite-plugin-svelte build",
     "test": "run-s test:serve test:build",
     "test:serve": "jest",
-    "test:serve:debug": "cross-env VITE_DEBUG_SERVE=1 node --inspect-brk ./node_modules/.bin/jest",
+    "test:serve:debug": "cross-env DEBUG=pw:api VITE_DEBUG_SERVE=1 node --inspect-brk ./node_modules/jest/bin/jest --runInBand",
     "test:build": "cross-env VITE_TEST_BUILD=1 jest",
-    "test:build:debug": "cross-env VITE_TEST_BUILD=1 VITE_PRESERVE_BUILD_ARTIFACTS=1 node --inspect-brk ./node_modules/.bin/jest",
+    "test:build:debug": "cross-env DEBUG=pw:api VITE_TEST_BUILD=1 VITE_PRESERVE_BUILD_ARTIFACTS=1 node --inspect-brk ./node_modules/jest/bin/jest --runInBand",
     "test:ci": "run-s test:ci:serve test:ci:build",
     "test:ci:serve": "cross-env VITE_PRESERVE_BUILD_ARTIFACTS=1 jest --verbose --no-cache --runInBand --force-exit --ci --json --outputFile=\"temp/serve/jest-results.json\"",
     "test:ci:build": "cross-env VITE_TEST_BUILD=1 VITE_PRESERVE_BUILD_ARTIFACTS=1 jest --verbose --no-cache --runInBand --force-exit --ci --json --outputFile=\"temp/build/jest-results.json\"",
@@ -27,14 +27,14 @@
     "@changesets/cli": "^2.16.0",
     "@types/fs-extra": "^9.0.11",
     "@types/jest": "^26.0.23",
-    "@types/node": "^15.12.4",
+    "@types/node": "^15.12.5",
     "@types/semver": "^7.3.6",
-    "@typescript-eslint/eslint-plugin": "^4.28.0",
-    "@typescript-eslint/parser": "^4.28.0",
+    "@typescript-eslint/eslint-plugin": "^4.28.1",
+    "@typescript-eslint/parser": "^4.28.1",
     "chalk": "^4.1.1",
     "cross-env": "^7.0.3",
     "enquirer": "^2.3.6",
-    "esbuild": "^0.12.9",
+    "esbuild": "^0.12.12",
     "eslint": "^7.29.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-html": "^6.1.2",
@@ -46,22 +46,22 @@
     "execa": "^5.1.1",
     "fs-extra": "^10.0.0",
     "husky": "^6.0.0",
-    "jest": "^27.0.5",
-    "jest-environment-node": "^27.0.5",
+    "jest": "^27.0.6",
+    "jest-environment-node": "^27.0.6",
     "jest-junit": "^12.2.0",
     "lint-staged": "^11.0.0",
     "minimist": "^1.2.5",
     "node-fetch": "^2.6.1",
     "npm-check-updates": "^11.7.1",
     "npm-run-all": "^4.1.5",
-    "playwright-core": "^1.12.2",
-    "pnpm": "^6.8.0",
-    "prettier": "^2.3.1",
+    "playwright-core": "^1.12.3",
+    "pnpm": "^6.9.1",
+    "prettier": "^2.3.2",
     "prettier-plugin-svelte": "^2.3.1",
     "rimraf": "^3.0.2",
     "semver": "^7.3.5",
     "sirv": "^1.0.12",
-    "svelte": "^3.38.2",
+    "svelte": "^3.38.3",
     "ts-jest": "^27.0.3",
     "typescript": "^4.3.4",
     "vite": "^2.3.8"

packages/e2e-tests/autoprefixer-browerslist/package.json

@@ -3,18 +3,19 @@
   "private": true,
   "version": "1.0.0",
   "scripts": {
+    "dev": "vite",
     "build": "vite build",
-    "dev": "vite"
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "e2e-tests-hmr-test-dependency": "workspace:*"
   },
-	"dependencies": {
-		"e2e-tests-hmr-test-dependency": "workspace:*"
-	},
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "autoprefixer": "^10.2.6",
     "postcss": "^8.3.5",
     "postcss-load-config": "^3.1.0",
-    "svelte": "^3.38.2",
+    "svelte": "^3.38.3",
     "svelte-hmr": "^0.14.4",
     "svelte-preprocess": "^4.7.3",
     "vite": "^2.3.8"

packages/e2e-tests/autoprefixer-browerslist/vite.config.js

@@ -1,12 +1,21 @@
 const { svelte } = require('@sveltejs/vite-plugin-svelte');
 const { defineConfig } = require('vite');
 
-module.exports = defineConfig(({ command, mode }) => {
-	const isProduction = mode === 'production';
+module.exports = defineConfig(() => {
 	return {
 		plugins: [svelte()],
 		build: {
-			minify: isProduction
+			// make build faster by skipping transforms and minification
+			target: 'esnext',
+			minify: false
+		},
+		server: {
+			watch: {
+				// During tests we edit the files too fast and sometimes chokidar
+				// misses change events, so enforce polling for consistency
+				usePolling: true,
+				interval: 100
+			}
 		}
 	};
 });

packages/e2e-tests/configfile-custom/package.json

@@ -3,17 +3,17 @@
   "private": true,
   "version": "1.0.0",
   "scripts": {
+    "dev": "vite",
     "build": "vite build",
-    "dev": "vite"
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "e2e-tests-hmr-test-dependency": "workspace:*"
   },
-	"dependencies": {
-		"e2e-tests-hmr-test-dependency": "workspace:*"
-	},
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
-    "svelte": "^3.38.2",
+    "svelte": "^3.38.3",
     "svelte-hmr": "^0.14.4",
-    "svelte-preprocess": "^4.7.3",
     "vite": "^2.3.8"
   }
 }

packages/e2e-tests/configfile-custom/svelte.config.custom.cjs

@@ -1,5 +1,3 @@
-const sveltePreprocess = require('svelte-preprocess');
-
 module.exports = {
-	preprocess: sveltePreprocess()
+	emitCss: false
 };

packages/e2e-tests/configfile-custom/svelte.config.custom.mjs

@@ -1,10 +1,3 @@
-/*
-const sveltePreprocess = require('svelte-preprocess');
-
-module.exports = {
-	preprocess: sveltePreprocess()
-};
-*/
 export default {
-	emitCss: true
+	emitCss: false
 }

packages/e2e-tests/configfile-custom/vite.config.js

@@ -1,12 +1,21 @@
 const { svelte } = require('@sveltejs/vite-plugin-svelte');
 const { defineConfig } = require('vite');
 
-module.exports = defineConfig(({ command, mode }) => {
-	const isProduction = mode === 'production';
+module.exports = defineConfig(() => {
 	return {
 		plugins: [svelte({ configFile: 'svelte.config.custom.cjs' })],
 		build: {
-			minify: isProduction
+			// make build faster by skipping transforms and minification
+			target: 'esnext',
+			minify: false
+		},
+		server: {
+			watch: {
+				// During tests we edit the files too fast and sometimes chokidar
+				// misses change events, so enforce polling for consistency
+				usePolling: true,
+				interval: 100
+			}
 		}
 	};
 });