rename prerendering to building, `remove config.kit.prerender.ena…

…bled` (#7762) * rename prerendering to building, remove config.kit.prerender.enabled (#7716) * fix docs * add notes
sveltejs · Nov 23, 2022 · a9a7e98 · a9a7e98
1 parent d44bf72
commit a9a7e98
Show file tree

Hide file tree

Showing 21 changed files with 32 additions and 117 deletions.
diff --git a/.changeset/silent-ducks-prove.md b/.changeset/silent-ducks-prove.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+[breaking] Rename `prerendering` to `building`, remove `config.kit.prerender.enabled`
diff --git a/documentation/docs/20-core-concepts/40-page-options.md b/documentation/docs/20-core-concepts/40-page-options.md
@@ -35,6 +35,8 @@ export const prerender = 'auto';
 
 The prerenderer will start at the root of your app and generate files for any prerenderable pages or `+server.js` routes it finds. Each page is scanned for `<a>` elements that point to other pages that are candidates for prerendering — because of this, you generally don't need to specify which pages should be accessed. If you _do_ need to specify which pages should be accessed by the prerenderer, you can do so with the `entries` option in the [prerender configuration](/docs/configuration#prerender).
 
+While prerendering, the value of `building` imported from [`$app/environment`](/docs/modules#$app-environment) will be `true`.
+
 #### Prerendering server routes
 
 Unlike the other page options, `prerender` also applies to `+server.js` files. These files are _not_ affected from layouts, but will inherit default values from the pages that fetch data from them, if any. For example if a `+page.js` contains this `load` function...

diff --git a/documentation/docs/50-api-reference/10-configuration.md b/documentation/docs/50-api-reference/10-configuration.md
@@ -55,7 +55,6 @@ const config = {
 		prerender: {
 			concurrency: 1,
 			crawl: true,
-			enabled: true,
 			entries: ['*'],
 			handleHttpError: 'fail',
 			handleMissingId: 'fail',
@@ -253,7 +252,6 @@ See [Prerendering](/docs/page-options#prerender). An object containing zero or m
 
 - `concurrency` — how many pages can be prerendered simultaneously. JS is single-threaded, but in cases where prerendering performance is network-bound (for example loading content from a remote CMS) this can speed things up by processing other tasks while waiting on the network response
 - `crawl` — determines whether SvelteKit should find pages to prerender by following links from the seed page(s)
-- `enabled` — set to `false` to disable prerendering altogether
 - `entries` — an array of pages to prerender, or start crawling from (if `crawl: true`). The `*` string includes all non-dynamic routes (i.e. pages with no `[parameters]`, because SvelteKit doesn't know what value the parameters should have)
 - `handleHttpError`
 

diff --git a/packages/kit/src/core/config/index.spec.js b/packages/kit/src/core/config/index.spec.js
@@ -113,7 +113,7 @@ const get_defaults = (prefix = '') => ({
 			crawl: true,
 			createIndexFiles: undefined,
 			default: undefined,
-			enabled: true,
+			enabled: undefined,
 			entries: ['*'],
 			force: undefined,
 			handleHttpError: 'fail',

diff --git a/packages/kit/src/core/config/options.js b/packages/kit/src/core/config/options.js
@@ -238,7 +238,10 @@ const options = object(
 					(keypath) =>
 						`${keypath} has been removed. You can set it inside the top level +layout.js instead. See the PR for more information: https://github.com/sveltejs/kit/pull/6197`
 				),
-				enabled: boolean(true),
+				enabled: error(
+					(keypath) =>
+						`${keypath} has been removed. You can wrap any code that should not be executed during build in a \`if (!building) {...}\` block. See the discussion for more information: https://github.com/sveltejs/kit/discussions/7716`
+				),
 				entries: validate(['*'], (input, keypath) => {
 					if (!Array.isArray(input) || !input.every((page) => typeof page === 'string')) {
 						throw new Error(`${keypath} must be an array of strings`);

diff --git a/packages/kit/src/core/prerender/prerender.js b/packages/kit/src/core/prerender/prerender.js
@@ -77,11 +77,6 @@ export async function prerender() {
 	/** @type {import('types').ValidatedKitConfig} */
 	const config = (await load_config()).kit;
 
-	if (!config.prerender.enabled) {
-		output_and_exit({ prerendered, prerender_map });
-		return;
-	}
-
 	/** @type {import('types').Logger} */
 	const log = logger({
 		verbose: verbose === 'true'
@@ -111,8 +106,8 @@ export async function prerender() {
 	const manifest = (await import(pathToFileURL(manifest_path).href)).manifest;
 
 	override({
+		building: true,
 		paths: config.paths,
-		prerendering: true,
 		read: (file) => readFileSync(join(config.files.assets, file))
 	});
 

diff --git a/packages/kit/src/exports/vite/build/build_server.js b/packages/kit/src/exports/vite/build/build_server.js
@@ -27,7 +27,7 @@ const server_template = ({ config, hooks, has_service_worker, runtime, template,
 import root from '__GENERATED__/root.svelte';
 import { respond } from '${runtime}/server/index.js';
 import { set_paths, assets, base } from '${runtime}/paths.js';
-import { set_prerendering, set_version } from '${runtime}/env.js';
+import { set_building, set_version } from '${runtime}/env.js';
 import { set_private_env } from '${runtime}/env-private.js';
 import { set_public_env } from '${runtime}/env-public.js';
 
@@ -53,7 +53,7 @@ let default_protocol = 'https';
 export function override(settings) {
 	default_protocol = settings.protocol || default_protocol;
 	set_paths(settings.paths);
-	set_prerendering(settings.prerendering);
+	set_building(settings.building);
 	read = settings.read;
 }
 

diff --git a/packages/kit/src/exports/vite/preview/index.js b/packages/kit/src/exports/vite/preview/index.js
@@ -39,7 +39,7 @@ export async function preview(vite, vite_config, svelte_config) {
 
 	override({
 		paths: { base, assets },
-		prerendering: false,
+		building: false,
 		protocol,
 		read: (file) => fs.readFileSync(join(svelte_config.kit.files.assets, file))
 	});

diff --git a/packages/kit/src/runtime/app/environment.js b/packages/kit/src/runtime/app/environment.js
@@ -8,4 +8,4 @@ export const browser = !import.meta.env.SSR;
  */
 export const dev = __SVELTEKIT_DEV__;
 
-export { prerendering, version } from '../env.js';
+export { building, version } from '../env.js';
diff --git a/packages/kit/src/runtime/env.js b/packages/kit/src/runtime/env.js
@@ -1,9 +1,9 @@
-export let prerendering = false;
+export let building = false;
 export let version = '';
 
 /** @param {boolean} value */
-export function set_prerendering(value) {
-	prerendering = value;
+export function set_building(value) {
+	building = value;
 }
 
 /** @param {string} value */

diff --git a/packages/kit/test/prerendering/basics/src/hooks.server.js b/packages/kit/test/prerendering/basics/src/hooks.server.js
@@ -1,15 +1,15 @@
-import { prerendering } from '$app/environment';
+import { building } from '$app/environment';
 
-const initial_prerendering = prerendering;
+const initial_building = building;
 
 /** @type {import('@sveltejs/kit').Handle} */
 export const handle = async ({ event, resolve }) => {
-	if (event.url.pathname === '/prerendering-true' && prerendering) {
+	if (event.url.pathname === '/prerendering-true' && building) {
 		return await resolve(event, {
 			transformPageChunk: ({ html }) =>
 				html
-					.replace('__INITIAL_PRERENDERING__', String(initial_prerendering))
-					.replace('__PRERENDERING__', String(prerendering))
+					.replace('__INITIAL_PRERENDERING__', String(initial_building))
+					.replace('__PRERENDERING__', String(building))
 		});
 	}
 	return await resolve(event, {

diff --git a/packages/kit/test/prerendering/fallback/package.json b/packages/kit/test/prerendering/fallback/package.json
diff --git a/packages/kit/test/prerendering/fallback/src/app.html b/packages/kit/test/prerendering/fallback/src/app.html
diff --git a/packages/kit/test/prerendering/fallback/src/hooks.server.js b/packages/kit/test/prerendering/fallback/src/hooks.server.js
diff --git a/packages/kit/test/prerendering/fallback/src/routes/+page.svelte b/packages/kit/test/prerendering/fallback/src/routes/+page.svelte
diff --git a/packages/kit/test/prerendering/fallback/svelte.config.js b/packages/kit/test/prerendering/fallback/svelte.config.js
diff --git a/packages/kit/test/prerendering/fallback/tsconfig.json b/packages/kit/test/prerendering/fallback/tsconfig.json
diff --git a/packages/kit/test/prerendering/fallback/vite.config.js b/packages/kit/test/prerendering/fallback/vite.config.js
diff --git a/packages/kit/types/ambient.d.ts b/packages/kit/types/ambient.d.ts
@@ -67,7 +67,7 @@ declare namespace App {
 
 /**
  * ```ts
- * import { browser, dev, prerendering } from '$app/environment';
+ * import { browser, building, dev, version } from '$app/environment';
  * ```
  */
 declare module '$app/environment' {
@@ -77,17 +77,17 @@ declare module '$app/environment' {
 	export const browser: boolean;
 
 	/**
-	 * Whether the dev server is running. This is not guaranteed to correspond to `NODE_ENV` or `MODE`.
+	 * SvelteKit analyses your app during the `build` step by running it. During this process, `building` is `true`. This also applies during prerendering.
 	 */
-	export const dev: boolean;
+	export const building: boolean;
 
 	/**
-	 * `true` when prerendering, `false` otherwise.
+	 * Whether the dev server is running. This is not guaranteed to correspond to `NODE_ENV` or `MODE`.
 	 */
-	export const prerendering: boolean;
+	export const dev: boolean;
 
 	/**
-	 * The value of `config.kit.version.name`
+	 * The value of `config.kit.version.name`.
 	 */
 	export const version: string;
 }

diff --git a/packages/kit/types/index.d.ts b/packages/kit/types/index.d.ts
@@ -213,7 +213,6 @@ export interface KitConfig {
 		concurrency?: number;
 		crawl?: boolean;
 		default?: boolean;
-		enabled?: boolean;
 		entries?: Array<'*' | `/${string}`>;
 		handleHttpError?: PrerenderHttpErrorHandlerValue;
 		handleMissingId?: PrerenderMissingIdHandlerValue;

diff --git a/packages/kit/types/internal.d.ts b/packages/kit/types/internal.d.ts
@@ -29,11 +29,11 @@ export interface ServerModule {
 	Server: typeof InternalServer;
 
 	override(options: {
+		building: boolean;
 		paths: {
 			base: string;
 			assets: string;
 		};
-		prerendering: boolean;
 		protocol?: 'http' | 'https';
 		read(file: string): Buffer;
 	}): void;