move config.kit.hydrate and config.kit.router to config.kit.browser (#…

…3578) * move config.kit.hydrate and config.kit.router to config.kit.browser * changeset
sveltejs · Jan 29, 2022 · 9e1386e · 9e1386e
1 parent 69124d8
commit 9e1386e
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 47 deletions.
diff --git a/.changeset/brown-dots-hang.md b/.changeset/brown-dots-hang.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+Move config.kit.hydrate and config.kit.router to config.kit.browser
diff --git a/packages/kit/src/core/build/build_client.js b/packages/kit/src/core/build/build_client.js
@@ -87,7 +87,7 @@ export async function build_client({
 				extensions: config.extensions,
 				emitCss: !config.kit.amp,
 				compilerOptions: {
-					hydratable: !!config.kit.hydrate
+					hydratable: !!config.kit.browser.hydrate
 				}
 			})
 		]

diff --git a/packages/kit/src/core/build/build_server.js b/packages/kit/src/core/build/build_server.js
@@ -79,7 +79,7 @@ export class App {
 				error.stack = this.options.get_stack(error);
 			},
 			hooks,
-			hydrate: ${s(config.kit.hydrate)},
+			hydrate: ${s(config.kit.browser.hydrate)},
 			manifest,
 			method_override: ${s(config.kit.methodOverride)},
 			paths: { base, assets },
@@ -88,7 +88,7 @@ export class App {
 			read,
 			root,
 			service_worker: ${has_service_worker ? "base + '/service-worker.js'" : 'null'},
-			router: ${s(config.kit.router)},
+			router: ${s(config.kit.browser.router)},
 			target: ${s(config.kit.target)},
 			template,
 			template_contains_nonce: ${template.includes('%svelte.nonce%')},
@@ -217,7 +217,7 @@ export async function build_server(
 			svelte({
 				extensions: config.extensions,
 				compilerOptions: {
-					hydratable: !!config.kit.hydrate
+					hydratable: !!config.kit.browser.hydrate
 				}
 			})
 		],

diff --git a/packages/kit/src/core/config/index.spec.js b/packages/kit/src/core/config/index.spec.js
@@ -14,6 +14,10 @@ const get_defaults = (prefix = '') => ({
 		adapter: null,
 		amp: false,
 		appDir: '_app',
+		browser: {
+			hydrate: true,
+			router: true
+		},
 		csp: {
 			mode: 'auto',
 			directives: {
@@ -61,7 +65,7 @@ const get_defaults = (prefix = '') => ({
 		floc: false,
 		headers: undefined,
 		host: undefined,
-		hydrate: true,
+		hydrate: undefined,
 		inlineStyleThreshold: 0,
 		methodOverride: {
 			parameter: '_method',
@@ -88,8 +92,8 @@ const get_defaults = (prefix = '') => ({
 			pages: undefined
 		},
 		protocol: undefined,
-		router: true,
-		ssr: null,
+		router: undefined,
+		ssr: undefined,
 		target: null,
 		trailingSlash: 'never'
 	}

diff --git a/packages/kit/src/core/config/options.js b/packages/kit/src/core/config/options.js
@@ -57,6 +57,11 @@ const options = object(
 				return input;
 			}),
 
+			browser: object({
+				hydrate: boolean(true),
+				router: boolean(true)
+			}),
+
 			csp: object({
 				mode: list(['auto', 'hash', 'nonce']),
 				directives: object({
@@ -106,24 +111,19 @@ const options = object(
 			floc: boolean(false),
 
 			// TODO: remove this for the 1.0 release
-			headers: validate(undefined, (input, keypath) => {
-				if (typeof input !== undefined) {
-					throw new Error(
-						`${keypath} has been removed. See https://github.com/sveltejs/kit/pull/3384 for details`
-					);
-				}
-			}),
+			headers: error(
+				(keypath) =>
+					`${keypath} has been removed. See https://github.com/sveltejs/kit/pull/3384 for details`
+			),
 
 			// TODO: remove this for the 1.0 release
-			host: validate(undefined, (input, keypath) => {
-				if (typeof input !== undefined) {
-					throw new Error(
-						`${keypath} has been removed. See https://github.com/sveltejs/kit/pull/3384 for details`
-					);
-				}
-			}),
+			host: error(
+				(keypath) =>
+					`${keypath} has been removed. See https://github.com/sveltejs/kit/pull/3384 for details`
+			),
 
-			hydrate: boolean(true),
+			// TODO remove for 1.0
+			hydrate: error((keypath) => `${keypath} has been moved to config.kit.browser.hydrate`),
 
 			inlineStyleThreshold: number(0),
 
@@ -225,23 +225,17 @@ const options = object(
 				}),
 
 				// TODO: remove this for the 1.0 release
-				pages: validate(undefined, (input, keypath) => {
-					if (typeof input !== undefined) {
-						throw new Error(`${keypath} has been renamed to \`entries\`.`);
-					}
-				})
+				pages: error((keypath) => `${keypath} has been renamed to \`entries\`.`)
 			}),
 
 			// TODO: remove this for the 1.0 release
-			protocol: validate(undefined, (input, keypath) => {
-				if (typeof input !== undefined) {
-					throw new Error(
-						`${keypath} has been removed. See https://github.com/sveltejs/kit/pull/3384 for details`
-					);
-				}
-			}),
+			protocol: error(
+				(keypath) =>
+					`${keypath} has been removed. See https://github.com/sveltejs/kit/pull/3384 for details`
+			),
 
-			router: boolean(true),
+			// TODO remove for 1.0
+			router: error((keypath) => `${keypath} has been moved to config.kit.browser.router`),
 
 			routes: fun((filepath) => !/(?:(?:^_|\/_)|(?:^\.|\/\.)(?!well-known))/.test(filepath)),
 
@@ -251,13 +245,10 @@ const options = object(
 			}),
 
 			// TODO remove this for 1.0
-			ssr: validate(null, (input) => {
-				if (input !== undefined) {
-					throw new Error(
-						'config.kit.ssr has been removed — use the handle hook instead: https://kit.svelte.dev/docs#hooks-handle'
-					);
-				}
-			}),
+			ssr: error(
+				(keypath) =>
+					`${keypath} has been removed — use the handle hook instead: https://kit.svelte.dev/docs#hooks-handle'`
+			),
 
 			target: string(null),
 
@@ -436,4 +427,13 @@ function assert_string(input, keypath) {
 	}
 }
 
+/** @param {(keypath?: string) => string} fn */
+function error(fn) {
+	return validate(undefined, (input, keypath) => {
+		if (input !== undefined) {
+			throw new Error(fn(keypath));
+		}
+	});
+}
+
 export default options;
diff --git a/packages/kit/src/core/dev/index.js b/packages/kit/src/core/dev/index.js
@@ -63,7 +63,7 @@ export async function dev({ cwd, port, host, https, config }) {
 				extensions: config.extensions,
 				emitCss: !config.kit.amp,
 				compilerOptions: {
-					hydratable: !!config.kit.hydrate
+					hydratable: !!config.kit.browser.hydrate
 				}
 			}),
 			await create_plugin(config, cwd)

diff --git a/packages/kit/src/core/dev/plugin.js b/packages/kit/src/core/dev/plugin.js
@@ -245,7 +245,7 @@ export async function create_plugin(config, cwd) {
 								});
 							},
 							hooks,
-							hydrate: config.kit.hydrate,
+							hydrate: config.kit.browser.hydrate,
 							manifest,
 							method_override: config.kit.methodOverride,
 							paths: {
@@ -256,7 +256,7 @@ export async function create_plugin(config, cwd) {
 							prerender: config.kit.prerender.enabled,
 							read: (file) => fs.readFileSync(path.join(config.kit.files.assets, file)),
 							root,
-							router: config.kit.router,
+							router: config.kit.browser.router,
 							target: config.kit.target,
 							template: ({ head, body, assets, nonce }) => {
 								return (

diff --git a/packages/kit/types/config.d.ts b/packages/kit/types/config.d.ts
@@ -118,6 +118,10 @@ export interface Config {
 		adapter?: Adapter;
 		amp?: boolean;
 		appDir?: string;
+		browser?: {
+			hydrate?: boolean;
+			router?: boolean;
+		};
 		csp?: {
 			mode?: 'hash' | 'nonce' | 'auto';
 			directives?: CspDirectives;
@@ -131,7 +135,6 @@ export interface Config {
 			template?: string;
 		};
 		floc?: boolean;
-		hydrate?: boolean;
 		inlineStyleThreshold?: number;
 		methodOverride?: {
 			parameter?: string;
@@ -154,7 +157,6 @@ export interface Config {
 			entries?: string[];
 			onError?: PrerenderOnErrorValue;
 		};
-		router?: boolean;
 		routes?: (filepath: string) => boolean;
 		serviceWorker?: {
 			register?: boolean;