From da036711bfa22298113a656362c56c1da9f0f95c Mon Sep 17 00:00:00 2001 From: Matthew Phillips Date: Mon, 14 Aug 2023 10:04:56 -0400 Subject: [PATCH 1/2] Update types to specify that compress defaults to true --- .changeset/tasty-camels-speak.md | 5 +++++ packages/astro/src/@types/astro.ts | 6 +++--- 2 files changed, 8 insertions(+), 3 deletions(-) create mode 100644 .changeset/tasty-camels-speak.md diff --git a/.changeset/tasty-camels-speak.md b/.changeset/tasty-camels-speak.md new file mode 100644 index 000000000000..374163d9b992 --- /dev/null +++ b/.changeset/tasty-camels-speak.md @@ -0,0 +1,5 @@ +--- +'astro': patch +--- + +Update Astro types to reflect that compress defaults to true diff --git a/packages/astro/src/@types/astro.ts b/packages/astro/src/@types/astro.ts index 4867728b1612..4ce91dc1f888 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -542,14 +542,14 @@ export interface AstroUserConfig { * @docs * @name compressHTML * @type {boolean} - * @default `false` + * @default `true` * @description * This is an option to minify your HTML output and reduce the size of your HTML files. When enabled, Astro removes all whitespace from your HTML, including line breaks, from `.astro` components. This occurs both in development mode and in the final build. - * To enable this, set the `compressHTML` flag to `true`. + * This is enabled by default; to disable this, set the `compressHTML` flag to `false`. * * ```js * { - * compressHTML: true + * compressHTML: false * } * ``` */ From 48d6c0c4efd8cf848624ffa84e4187e7b2511241 Mon Sep 17 00:00:00 2001 From: Sarah Rainsberger Date: Mon, 14 Aug 2023 11:15:35 -0300 Subject: [PATCH 2/2] Update astro.ts --- 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 4ce91dc1f888..8bdd351731ff 100644 --- a/packages/astro/src/@types/astro.ts +++ b/packages/astro/src/@types/astro.ts @@ -544,8 +544,8 @@ export interface AstroUserConfig { * @type {boolean} * @default `true` * @description - * This is an option to minify your HTML output and reduce the size of your HTML files. When enabled, Astro removes all whitespace from your HTML, including line breaks, from `.astro` components. This occurs both in development mode and in the final build. - * This is enabled by default; to disable this, set the `compressHTML` flag to `false`. + * This is an option to minify your HTML output and reduce the size of your HTML files. By default, Astro removes all whitespace from your HTML, including line breaks, from `.astro` components. This occurs both in development mode and in the final build. + * To disable HTML compression, set the `compressHTML` flag to `false`. * * ```js * {