From 4477bb41c8ed688785c545731ef5b184b629f4e5 Mon Sep 17 00:00:00 2001 From: Matthew Phillips Date: Mon, 14 Aug 2023 11:10:37 -0400 Subject: [PATCH] Update types to specify that compress defaults to true (#8072) * Update types to specify that compress defaults to true * Update astro.ts --------- Co-authored-by: Sarah Rainsberger --- .changeset/tasty-camels-speak.md | 5 +++++ packages/astro/src/@types/astro.ts | 8 ++++---- 2 files changed, 9 insertions(+), 4 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..8bdd351731ff 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 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 * { - * compressHTML: true + * compressHTML: false * } * ``` */