Postinstall sync

.changeset/soft-masks-trade.md

@@ -0,0 +1,6 @@
+---
+'create-svelte': patch
+'@sveltejs/kit': patch
+---
+
+Use @sveltejs/kit postinstall lifecycle hook to invoke 'svelte-kit sync' instead of prepare in projects created by create-svelte

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       # not needed for linting
-      PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: "1"
+      PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: '1'
     steps:
       - uses: actions/checkout@v3
       - uses: pnpm/[email protected]
@@ -38,7 +38,7 @@ jobs:
       fail-fast: false
       matrix:
         node-version: [16]
-        os: [ubuntu-latest , windows-latest]
+        os: [ubuntu-latest, windows-latest]
         e2e-browser: ['chromium']
         include:
           - node-version: 16
@@ -53,7 +53,7 @@ jobs:
     env:
       TURBO_CACHE_KEY: ${{ matrix.os }}-${{ matrix.node-version }}
       # Install playwright's binray under node_modules so it will be cached together
-      PLAYWRIGHT_BROWSERS_PATH: "0"
+      PLAYWRIGHT_BROWSERS_PATH: '0'
       KIT_E2E_BROWSER: ${{matrix.e2e-browser}}
     steps:
       - run: git config --global core.autocrlf false

packages/create-svelte/templates/default/package.template.json

@@ -5,8 +5,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"package": "svelte-kit package",
-		"preview": "vite preview",
-		"prepare": "svelte-kit sync"
+		"preview": "vite preview"
 	},
 	"devDependencies": {
 		"@sveltejs/adapter-auto": "next",

packages/create-svelte/templates/skeleton/package.template.json

@@ -5,8 +5,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"package": "svelte-kit package",
-		"preview": "vite preview",
-		"prepare": "svelte-kit sync"
+		"preview": "vite preview"
 	},
 	"devDependencies": {
 		"@sveltejs/adapter-auto": "workspace:*",

packages/kit/package.json

@@ -72,7 +72,8 @@
 		"test:unit": "uvu src \"(spec\\.js|test[\\\\/]index\\.js)\" -i packaging",
 		"test:typings": "tsc --project test/typings",
 		"test:packaging": "uvu src/packaging \"(spec\\.js|test[\\\\/]index\\.js)\"",
-		"types": "node scripts/extract-types.js"
+		"types": "node scripts/extract-types.js",
+		"postinstall": "node svelte-kit.js sync"
 	},
 	"exports": {
 		"./package.json": "./package.json",

packages/kit/src/cli.js

@@ -1,4 +1,5 @@
 import fs from 'fs';
+import path from 'path';
 import colors from 'kleur';
 import sade from 'sade';
 import { load_config } from './core/config/index.js';
@@ -40,13 +41,25 @@ prog
 	.describe('Synchronise generated files')
 	.option('--mode', 'Specify a mode for loading environment variables', 'development')
 	.action(async ({ mode }) => {
-		if (!fs.existsSync('svelte.config.js')) {
-			console.warn('Missing svelte.config.js — skipping');
+		const event = process.env.npm_lifecycle_event;
+
+		// TODO remove for 1.0
+		if (event === 'prepare') {
+			const message = `\`svelte-kit sync\` now runs on "postinstall" — please remove the "prepare" script from your package.json\n`;
+			console.error(colors.bold().red(message));
+			return;
+		}
+
+		const cwd = event === 'postinstall' ? process.env.INIT_CWD ?? '' : process.cwd();
+
+		const svelte_config_file = path.join(cwd, 'svelte.config.js');
+		if (!fs.existsSync(svelte_config_file)) {
+			console.warn(`Missing ${svelte_config_file} — skipping`);
 			return;
 		}
 
 		try {
-			const config = await load_config();
+			const config = await load_config({ cwd });
 			const sync = await import('./core/sync/sync.js');
 			sync.all(config, mode);
 		} catch (error) {

packages/kit/svelte-kit.js

@@ -1,2 +1,11 @@
 #!/usr/bin/env node
-import './dist/cli.js';
+import fs from 'fs';
+import { fileURLToPath } from 'url';
+
+// in our own CI, and when deploying directly from this monorepo,
+// the `dist` directory will not exist yet
+if (fs.existsSync(fileURLToPath(new URL('./dist', import.meta.url)))) {
+	import('./dist/cli.js');
+} else {
+	console.error('Run "pnpm build" and try running this command again');
+}

packages/kit/test/apps/amp/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run test:dev && npm run test:build",
 		"test:dev": "cross-env DEV=true playwright test",
 		"test:build": "playwright test"

packages/kit/test/apps/basics/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run test:dev && npm run test:build",
 		"test:dev": "rimraf test/errors.json && cross-env DEV=true playwright test",
 		"test:build": "rimraf test/errors.json && playwright test"

packages/kit/test/apps/options-2/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run test:dev && npm run test:build",
 		"test:dev": "cross-env DEV=true playwright test",
 		"test:build": "playwright test"

packages/kit/test/apps/options/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev -c vite.custom.config.js",
 		"build": "vite build -c vite.custom.config.js --mode custom",
 		"preview": "vite preview -c vite.custom.config.js",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run test:dev && npm run test:build",
 		"test:dev": "cross-env DEV=true playwright test",
 		"test:build": "playwright test"

packages/kit/test/apps/writes/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run test:dev && npm run test:build",
 		"test:dev": "rimraf test/errors.json && cross-env DEV=true playwright test",
 		"test:build": "rimraf test/errors.json && playwright test"

packages/kit/test/prerendering/basics/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run build && uvu test"
 	},
 	"devDependencies": {

packages/kit/test/prerendering/fallback/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run build"
 	},
 	"devDependencies": {

packages/kit/test/prerendering/options/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run build && uvu test"
 	},
 	"devDependencies": {

packages/kit/test/prerendering/paths-base/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run build && uvu test"
 	},
 	"devDependencies": {

packages/kit/test/prerendering/trailing-slash/package.json

@@ -6,8 +6,7 @@
 		"dev": "vite dev",
 		"build": "vite build",
 		"preview": "vite preview",
-		"prepare": "node ../../cli.js sync",
-		"check": "tsc && svelte-check",
+		"check": "svelte-kit sync && tsc && svelte-check",
 		"test": "npm run build && uvu test"
 	},
 	"devDependencies": {