This package has been deprecated

Author message:

compress-astro has been deprecated, use @playform/compress

Related:
Critters 🦔 Inline CSS.		Biome 🗻 Biome Format.

🗜️ CompressAstro

This Astro integration brings compression utilities to your Astro project.

CSS / HTML / JavaScript / Image / SVG

Note

CompressAstro will not compress your requests, only your statically generated build and pre-rendered routes.

[!IMPORTANT]

Use CompressAstro last in your integration list for the best optimization.

Installation

There are two ways to add integrations to your project. Let's try the most convenient option first!

astro add command

Astro includes a CLI tool for adding first party integrations: astro add. This command will:

1. (Optionally) Install all necessary dependencies and peer dependencies
2. (Also optionally) Update your astro.config.* file to apply this integration

To install CompressAstro, run the following from your project directory and follow the prompts:

Using NPM:

npx astro add compress-astro

Using Yarn:

yarn astro add compress-astro

Using PNPM:

pnpx astro add compress-astro

Install dependencies manually

First, install the CompressAstro integration like so:

npm install -D -E compress-astro

Then, apply this integration to your astro.config.* file using the integrations property:

astro.config.ts

export default { integrations: [(await import("compress-astro")).default()] };

Getting started

The utility will now automatically compress all your CSS, HTML, SVG, JavaScript and image files in the Astro outDir folder.

The following image file types will be compressed via sharp:

• avci
• avcs
• avif
• avifs
• gif
• heic
• heics
• heif
• heifs
• jfif
• jif
• jpe
• jpeg
• jpg
• apng
• png
• raw
• tiff
• webp

SVG compression is supported via svgo.

Default Compression

You can override any of the default options from the configurations of:

• csso
• html-minifier-terser
• sharp
• svgo
• terser

or disable them entirely:

astro.config.ts

export default {
	integrations: [
		(await import("compress-astro")).default({
			CSS: false,
			HTML: false,
			Image: false,
			JavaScript: false,
			SVG: false,
		}),
	],
};

You can see the full option map here: Source/Interface/Option.ts

Output

By default CompressAstro compresses the outDir Astro directory, if you'd like it to compress a different directory you would have to add it to the CompressAstro Path option, as well:

export default {
	integrations: [
		(await import("compress-astro")).default({
			Path: ["./dist", "./Compress"],
		}),
	],
};

Add Multiple Paths

You can add multiple paths to compress by specifying an array as the Path variable.

astro.config.ts

export default {
	integrations: [
		(await import("compress-astro")).default({
			Path: ["./Target", "./Build"],
		}),
	],
};

Input-Output Mapping

You can also provide a map of paths for different input output directories.

astro.config.ts

export default {
	integrations: [
		(await import("compress-astro")).default({
			Path: new Map([["./Source", "./Target"]]),
		}),
	],
};

Or an array of the two:

astro.config.ts

export default {
	integrations: [
		(await import("compress-astro")).default({
			Path: [
				// Compress Target
				"./Target",
				// Compress Target one more time into a different directory
				new Map([["./Target", "./TargetCompress"]]),
			],
		}),
	],
};

File Filtering

You can filter files to exclude specific ones from compression. A filter can be an array of regular expressions or a single match. You can also use functions to match on file names:

astro.config.ts

export default {
	integrations: [
		(await import("compress-astro")).default({
			Exclude: [
				"File.png",
				(File: string) =>
					File === "./Target/Favicon/Image/safari-pinned-tab.svg",
			],
		}),
	],
};

Controlling Logging

You can control the logging level by setting the Logger parameter. The default value is 2, but you can set it to 0 if you don't want to see debug messages:

astro.config.ts

export default {
	integrations: [
		(await import("compress-astro")).default({
			Logger: 0,
		}),
	],
};

Changelog

See CHANGELOG.md for a history of changes to this integration.