CompressedStaticFiles 2.0.0

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package CompressedStaticFiles --version 2.0.0                

                    
                

            
NuGet\Install-Package CompressedStaticFiles -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="CompressedStaticFiles" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add CompressedStaticFiles --version 2.0.0                

                    
                

            
#r "nuget: CompressedStaticFiles, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install CompressedStaticFiles as a Cake Addin
#addin nuget:?package=CompressedStaticFiles&version=2.0.0

// Install CompressedStaticFiles as a Cake Tool
#tool nuget:?package=CompressedStaticFiles&version=2.0.0

Table of Contents

About The Project

This project allows you to server precompressed files to the browser without having to compress on demand, this is achieved by compressing/encoding your content at build time.

Getting Started

Precompress content

Static nonimage files have to be precompressed using Zopfli and/or Brotli, see the example for how to do it with gulp. The files must have the exact same filename as the source + .br or .gzip (index.html would be index.html.br for the Brotli version).

Encode images

Modern browsers support new image formates like webp and avif they can store more pixels per byte. You can convert your images using the following tools webp and libavif. The files must have the same filename as the source but with a new file extension (image.jpg would be image.webp for the webp version).

ASP.NET

Add AddCompressedStaticFiles() in your Startup.ConfigureServices() method. Replace UseStaticFiles(); with UseCompressedStaticFiles(); in Startup.Configure(). By default CompressedStaticFiles is configured to allow slightly larger files for some image formats as they can store more pixels per byte, this can be disabled by calling CompressedStaticFileOptions.RemoveImageSubstitutionCostRatio().

Example

A example can be found in the Example directory. By using this package the Lighthouse mobile performance went from 76 to 98 and the transferred size went from 526 kb to 141 kb.

Acknowledgements

This solution is based on @neyromant from the following issue https://github.com/aspnet/Home/issues/1584#issuecomment-227455026.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.1 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETCoreApp 3.1

    • No dependencies.

  • net5.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.2.0 41,458 3/23/2024
2.1.0 171,496 9/7/2022
2.0.0 165,154 11/11/2020
1.1.0 29,885 4/20/2020
1.0.4 43,509 10/19/2018
1.0.3 17,490 4/11/2017
1.0.2 9,811 8/22/2016
1.0.1 1,833 7/28/2016
1.0.0 1,741 7/20/2016

2.0.0
Added support for alternative image formats
Added support for .net 5
Removed support for .net core 2.1
1.2.0
Added support for .net core 3.1
1.1.0
New feature: Ability to specify a custom FileProvider (now using the FileProvider provided in the StaticFileOptions if it is set)
1.0.4
Converted to .NET Standard 1.6
1.0.3
Fixed issue that disabled caching parameters.
1.0.2
Added support for IIS.
1.0.1
Added logging
Picks original file if its the smallest
Added support for .NETFramework 4.5.1

1.0.0
Initial release