astro-compress 🗜️

WARNING As of now, this library is not maintained. Please look for suitable alternatives.

This Astro integration brings compression utilities to your Astro project.

CSS HTML JavaScript Images SVG

Note

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

Note

Use astro-compress last in your integration list for the best optimizations.

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 astro-compress, run the following from your project directory and follow the prompts:

Using NPM:

npx astro add astro-compress

Using Yarn:

yarn astro add astro-compress

Using PNPM:

pnpx astro add astro-compress

Install dependencies manually

First, install the astro-compress integration like so:

npm install -D -E astro-compress

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

astro.config.ts

import compress from "astro-compress";

export default { integrations: [compress()] };

Getting started

The utility will now automatically compress all your CSS, HTML, SVG, JavaScript and image files in the dist 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.

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

import compress from "astro-compress";

export default {
	integrations: [
		compress({
			css: false,
			html: false,
			img: false,
			js: false,
			svg: false,
		}),
	],
};

If your path is different than dist be sure to update it accordingly:

astro.config.ts

import compress from "astro-compress";

export default {
	outDir: "./build",
	integrations: [
		compress({
			path: "./build",
		}),
	],
};

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

astro.config.ts

import compress from "astro-compress";

export default {
	integrations: [
		compress({
			path: ["./build", "./dist"],
		}),
	],
};

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

astro.config.ts

import compress from "astro-compress";

export default {
	integrations: [
		compress({
			path: new Map([["./input", "./output"]]),
		}),
	],
};

Or an array of the two.

astro.config.ts

import compress from "astro-compress";

export default {
	integrations: [
		compress({
			path: [
				// Compress dist
				"./dist",

				// Compress dist one more time into a different directory
				new Map([["./dist", "./dist-compressed"]]),
			],
		}),
	],
};

You can provide a filter to exclude files in your build. A filter can be an array of regexes or a single match. You can use functions, as well to match on file names.

astro.config.ts

import compress from "astro-compress";

export default {
	integrations: [
		compress({
			exclude: [
				"my-awesome.png",
				(file: string) =>
					file === "./dist/img/favicon/safari-pinned-tab.svg",
			],
		}),
	],
};

Set logger to 0 if you do not want to see debug messages. Default is 2.

astro.config.ts

import compress from "astro-compress";

export default {
	integrations: [
		compress({
			logger: 0,
		}),
	],
};

Changelog

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

Built with Lightrix/npm, powered by Lightrix/files-pipe.