Rename mode to output

Author: matthewp

.changeset/famous-coins-destroy.md

@@ -18,7 +18,7 @@ This change introduces a new configuration option `mode`. Mode can be either
 
 The default, `static`, can be omitted from your config file.
 
-If you want to use SSR you now need to provide `mode: 'server'` *in addition* to an adapter.
+If you want to use SSR you now need to provide `output: 'server'` *in addition* to an adapter.
 
 The `adapter` configuration has been renamed to `deploy`. In the future adapters will support configuring a static site as well!
 
@@ -31,6 +31,6 @@ import netlify from '@astrojs/netlify/functions';
 export default defineConfig({
 -  adapter: netlify(),
 +  deploy: netlify(),
-+  mode: 'server',
++  output: 'server',
 });
 ```

examples/ssr/astro.config.mjs

@@ -4,7 +4,7 @@ import node from '@astrojs/node';
 
 // https://astro.build/config
 export default defineConfig({
-	mode: 'server',
+	output: 'server',
 	deploy: node(),
 	integrations: [svelte()],
 });

packages/astro/src/@types/astro.ts

@@ -638,8 +638,26 @@ export interface AstroUserConfig {
 	 */
 	deploy?: AstroIntegration;
 
-	// TODO: Document
-	mode?: 'static' | 'server';
+	/**
+	 * @docs
+	 * @kind heading
+	 * @name Output
+	 * @description
+	 * 
+	 * Specifies the output target for builds. 
+	 * 
+	 * - 'static' - Building a static site to be deploy to any static host.
+	 * - 'server' - Building an app to be deployed to a host supporting SSR (server-side rendering).
+	 * 
+	 * ```js
+	 * import { defineConfig } from 'astro/config';
+	 * 
+	 * export default defineConfig({
+	 *   output: 'static'
+	 * })
+	 * ```
+	 */
+	output?: 'static' | 'server';
 
 
 	/**

packages/astro/src/core/build/generate.ts

@@ -97,7 +97,7 @@ export async function generatePages(
 	const timer = performance.now();
 	info(opts.logging, null, `\n${bgGreen(black(' generating static routes '))}`);
 
-	const ssr = opts.astroConfig.mode === 'server';
+	const ssr = opts.astroConfig.output === 'server';
 	const serverEntry = opts.buildConfig.serverEntry;
 	const outFolder = ssr ? opts.buildConfig.server : opts.astroConfig.outDir;
 	const ssrEntryURL = new URL('./' + serverEntry + `?time=${Date.now()}`, outFolder);
@@ -207,7 +207,7 @@ async function generatePath(
 		}
 	}
 
-	const ssr = opts.astroConfig.mode === 'server';
+	const ssr = opts.astroConfig.output === 'server';
 	const url = new URL(opts.astroConfig.base + removeLeadingForwardSlash(pathname), origin);
 	const options: RenderOptions = {
 		adapterName: undefined,

packages/astro/src/core/build/index.ts

@@ -102,7 +102,7 @@ class AstroBuilder {
 		await runHookBuildStart({ config: this.config, buildConfig });
 
 		const getPrettyDeployTarget = (adapter: AstroAdapter | undefined) => adapter?.name || 'unknown';
-		info(this.logging, 'build', `build target: ${colors.green(this.config.mode)}`);
+		info(this.logging, 'build', `build target: ${colors.green(this.config.output)}`);
 		info(this.logging, 'build', `deploy target: ${colors.green(getPrettyDeployTarget(this.config._ctx.adapter))}`);
 		info(this.logging, 'build', 'Collecting build info...');
 		this.timer.loadStart = performance.now();
@@ -113,7 +113,7 @@ class AstroBuilder {
 			origin,
 			routeCache: this.routeCache,
 			viteServer,
-			ssr: this.config.mode === 'server',
+			ssr: this.config.output === 'server',
 		});
 
 		debug('build', timerMessage('All pages loaded', this.timer.loadStart));
@@ -174,7 +174,7 @@ class AstroBuilder {
 				logging: this.logging,
 				timeStart: this.timer.init,
 				pageCount: pageNames.length,
-				buildMode: this.config.mode,
+				buildMode: this.config.output,
 			});
 		}
 	}

packages/astro/src/core/build/page-data.ts

@@ -68,7 +68,7 @@ export async function collectPagesData(
 			};
 
 			clearInterval(routeCollectionLogTimeout);
-			if (astroConfig.mode === 'static') {
+			if (astroConfig.output === 'static') {
 				const html = `${route.pathname}`.replace(/\/?$/, '/index.html');
 				debug(
 					'build',

packages/astro/src/core/build/static-build.ts

@@ -26,10 +26,10 @@ export async function staticBuild(opts: StaticBuildOptions) {
 
 	// Verify this app is buildable.
 	if(isModeServerWithNoAdapter(opts.astroConfig)) {
-		throw new Error(`Cannot use mode: 'server' without an adapter. Please install and configure an adapter by setting it on the deploy configuration.
+		throw new Error(`Cannot use output: 'server' without an adapter. Please install and configure an adapter by setting it on the deploy configuration.
 		
 export default {
-	mode: 'static',
+	output: 'static',
 	adapter: netlify(),
 }`)
 	}
@@ -69,7 +69,7 @@ export default {
 	info(
 		opts.logging,
 		'build',
-		`Building ${astroConfig.mode} entrypoints...`
+		`Building ${astroConfig.output} entrypoints...`
 	);
 	const ssrResult = (await ssrBuild(opts, internals, pageInput)) as RollupOutput;
 	info(opts.logging, 'build', dim(`Completed in ${getTimeStat(timer.ssr, performance.now())}.`));
@@ -90,7 +90,7 @@ export default {
 	await clientBuild(opts, internals, clientInput);
 
 	timer.generate = performance.now();
-	if (astroConfig.mode === 'static') {
+	if (astroConfig.output === 'static') {
 		try {
 			await generatePages(ssrResult, opts, internals, facadeIdToPageDataMap);
 		} finally {
@@ -107,7 +107,7 @@ export default {
 
 async function ssrBuild(opts: StaticBuildOptions, internals: BuildInternals, input: Set<string>) {
 	const { astroConfig, viteConfig } = opts;
-	const ssr = astroConfig.mode === 'server';
+	const ssr = astroConfig.output === 'server';
 	const out = ssr ? opts.buildConfig.server : astroConfig.outDir;
 
 	const viteBuildConfig: ViteConfigWithSSR = {
@@ -151,7 +151,7 @@ async function ssrBuild(opts: StaticBuildOptions, internals: BuildInternals, inp
 			}),
 			...(viteConfig.plugins || []),
 			// SSR needs to be last
-			opts.astroConfig.mode === 'server' && vitePluginSSR(internals, opts.astroConfig._ctx.adapter!),
+			opts.astroConfig.output === 'server' && vitePluginSSR(internals, opts.astroConfig._ctx.adapter!),
 			vitePluginAnalyzer(opts.astroConfig, internals),
 		],
 		publicDir: ssr ? false : viteConfig.publicDir,
@@ -181,7 +181,7 @@ async function clientBuild(
 ) {
 	const { astroConfig, viteConfig } = opts;
 	const timer = performance.now();
-	const ssr = astroConfig.mode === 'server';
+	const ssr = astroConfig.output === 'server';
 	const out = ssr ? opts.buildConfig.client : astroConfig.outDir;
 
 	// Nothing to do if there is no client-side JS.
@@ -282,7 +282,7 @@ async function copyFiles(fromFolder: URL, toFolder: URL) {
 
 async function ssrMoveAssets(opts: StaticBuildOptions) {
 	info(opts.logging, 'build', 'Rearranging server assets...');
-	const serverRoot = opts.astroConfig.mode === 'static'
+	const serverRoot = opts.astroConfig.output === 'static'
 		? opts.buildConfig.client
 		: opts.buildConfig.server;
 	const clientRoot = opts.buildConfig.client;

packages/astro/src/core/build/vite-plugin-pages.ts

@@ -10,7 +10,7 @@ export function vitePluginPages(opts: StaticBuildOptions, internals: BuildIntern
 		name: '@astro/plugin-build-pages',
 
 		options(options) {
-			if (opts.astroConfig.mode === 'static') {
+			if (opts.astroConfig.output === 'static') {
 				return addRollupInput(options, [pagesVirtualModuleId]);
 			}
 		},

packages/astro/src/core/config.ts

@@ -124,7 +124,7 @@ export const AstroConfigSchema = z.object({
 		.union([z.literal('always'), z.literal('never'), z.literal('ignore')])
 		.optional()
 		.default(ASTRO_CONFIG_DEFAULTS.trailingSlash),
-	mode: z
+	output: z
 	.union([z.literal('static'), z.literal('server')])
 	.optional()
 	.default('static'),

packages/astro/src/core/endpoint/dev/index.ts

@@ -7,6 +7,6 @@ export async function call(ssrOpts: SSROptions) {
 	const [, mod] = await preload(ssrOpts);
 	return await callEndpoint(mod as unknown as EndpointHandler, {
 		...ssrOpts,
-		ssr: ssrOpts.astroConfig.mode === 'server',
+		ssr: ssrOpts.astroConfig.output === 'server',
 	});
 }