From 223bd6a87ff1250bc45c8b81dcb10e20c17c3152 Mon Sep 17 00:00:00 2001 From: Sarah Rainsberger Date: Sat, 19 Aug 2023 13:03:17 -0300 Subject: [PATCH 1/2] [docs] deprecate build.split and build.excludeMiddleware in config reference --- packages/astro/src/@types/astro.ts | 32 +++++++----------------------- 1 file changed, 7 insertions(+), 25 deletions(-) diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 1198b26be133..cff4aa97c124 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -859,22 +859,12 @@ export interface AstroUserConfig { * @name build.split * @type {boolean} * @default `false` - * @version 2.7.0 + * @deprecated since version 3.0 * @description - * Defines how the SSR code should be bundled when built. + * The build config option `build.split` has been replaced by the adapter configuration option `functionPerRoute`. * - * When `split` is `true`, Astro will emit a file for each page. - * Each file emitted will render only one page. The pages will be emitted - * inside a `dist/pages/` directory, and the emitted files will keep the same file paths - * of the `src/pages` directory. - * - * ```js - * { - * build: { - * split: true - * } - * } - * ``` + * Please see your [SSR adapter's documentation](/en/guides/integrations-guide/#official-integrations) for using `functionPerRoute` to define how your SSR code is bundled. + * */ split?: boolean; @@ -883,19 +873,11 @@ export interface AstroUserConfig { * @name build.excludeMiddleware * @type {boolean} * @default `false` - * @version 2.8.0 + * @deprecated since version 3.0 * @description - * Defines whether or not any SSR middleware code will be bundled when built. + * The build config option `build.excludeMiddleware` has been replaced by the adapter configuration option `edgeMiddleware`. * - * When enabled, middleware code is not bundled and imported by all pages during the build. To instead execute and import middleware code manually, set `build.excludeMiddleware: true`: - * - * ```js - * { - * build: { - * excludeMiddleware: true - * } - * } - * ``` + * Please see your [SSR adapter's documentation](/en/guides/integrations-guide/#official-integrations) for using `edgeMiddleware` to define whether or not any SSR middleware code will be bundled when built. */ excludeMiddleware?: boolean; }; From 88b53b5941c142723defa98e7d357a3a008399e9 Mon Sep 17 00:00:00 2001 From: Sarah Rainsberger Date: Mon, 21 Aug 2023 09:41:35 -0300 Subject: [PATCH 2/2] links will work in v3.0 docs site --- packages/astro/src/@types/astro.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index cff4aa97c124..e9c5169181af 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -861,7 +861,7 @@ export interface AstroUserConfig { * @default `false` * @deprecated since version 3.0 * @description - * The build config option `build.split` has been replaced by the adapter configuration option `functionPerRoute`. + * The build config option `build.split` has been replaced by the adapter configuration option [`functionPerRoute`](/en/reference/adapter-reference/#functionperroute). * * Please see your [SSR adapter's documentation](/en/guides/integrations-guide/#official-integrations) for using `functionPerRoute` to define how your SSR code is bundled. * @@ -875,7 +875,7 @@ export interface AstroUserConfig { * @default `false` * @deprecated since version 3.0 * @description - * The build config option `build.excludeMiddleware` has been replaced by the adapter configuration option `edgeMiddleware`. + * The build config option `build.excludeMiddleware` has been replaced by the adapter configuration option [`edgeMiddleware`](/en/reference/adapter-reference/#edgemiddleware). * * Please see your [SSR adapter's documentation](/en/guides/integrations-guide/#official-integrations) for using `edgeMiddleware` to define whether or not any SSR middleware code will be bundled when built. */