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 <sarah@rainsberger.ca>
withastro · Aug 14, 2023 · 4477bb4 · 4477bb4
1 parent 5208a3c
commit 4477bb4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/.changeset/tasty-camels-speak.md 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
@@ -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
 	 * }
 	 * ```
 	 */