npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

Iโ€™ve always been into building performant and accessible sites, but lately Iโ€™ve been taking it extremely seriously. So much so that Iโ€™ve been building a tool to help me optimize and monitor the sites that I build to make sure that Iโ€™m making an attempt to offer the best experience to those who visit them. If youโ€™re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, ๐Ÿ‘‹, Iโ€™m Ryan Hefnerย  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If youโ€™re interested in other things Iโ€™m working on, follow me on Twitter or check out the open source projects Iโ€™ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soonโ€“ish.

Open Software & Tools

This site wouldnโ€™t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you ๐Ÿ™

ยฉ 2024 โ€“ย Pkg Stats / Ryan Hefner

astro-compress

v2.3.5

Published

๐Ÿ—œ๏ธโ€Compressโ€โ€”

Downloads

49,734

Readme

๐Ÿ—œ๏ธโ€Compressโ€โ€”

This Astro integration brings compression utilities to your Astro project.

๐ŸŽโ€CSS (csso)โ€โ€”

๐ŸŽโ€CSS (lightningcss)โ€โ€”

๐ŸŽโ€HTML (html-minifier-terser)โ€โ€”

๐ŸŽโ€Image (sharp)โ€โ€”

๐ŸŽโ€JavaScript (terser)โ€โ€”

๐ŸŽโ€SVG (svgo)โ€โ€”

Note

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

[!IMPORTANT]

Use 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 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 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

export default {
	integrations: [(await import("astro-compress")).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, as well via [svgo].

Default Compression

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

astro.config.ts

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

or disable them entirely:

astro.config.ts

export default {
	integrations: [
		(await import("astro-compress")).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 Compress compresses the outDir Astro directory, if you'd like it to compress a different directory you would have to add it to the Compress Path option, as well:

export default {
	integrations: [
		(await import("astro-compress")).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("astro-compress")).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("astro-compress")).default({
			Path: new Map([["./Source", "./Target"]]),
		}),
	],
};

Or an array of the two:

astro.config.ts

export default {
	integrations: [
		(await import("astro-compress")).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("astro-compress")).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("astro-compress")).default({
			Logger: 0,
		}),
	],
};

Changelog

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