ASP.NET Extensions - Taritsyn/WebMarkupMin GitHub Wiki

Prior to WebMarkupMin version 2.0, configuring of ASP.NET extensions were made by using the Web.config file. Now during configuration instead of the declarative approach (using the configuration file) is used in the imperative approach (using the program code).

The rejection of the declarative approach was due to the following reasons:

1. Microsoft for several years, uses an imperative approach for configuration of individual parts of ASP.NET (for example, Web API or Web Optimization Framework).
2. ASP.NET Core has only limited support of Web.config files (mainly for integration with IIS).

Extensions for ASP.NET 4.X and ASP.NET Core 1.X use different configuration models. In ASP.NET 4.X configuring of extensions are made through special classes: WebMarkupMinConfiguration, HtmlMinificationManager, XhtmlMinificationManager, XmlMinificationManager and HttpCompressionManager. In ASP.NET Core 1.X configuration of extension is based on the Options framework and using the following classes: WebMarkupMinOptions, HtmlMinificationOptions, XhtmlMinificationOptions, XmlMinificationOptions and HttpCompressionOptions. However, these configuration models have a lot in common.

WebMarkupMinConfiguration and WebMarkupMinOptions classes inherit WebMarkupMinConfigurationBase class, which has the following properties:

All classes of markup minification and compression managers (and their options) have IncludedPages and ExcludedPages properties, that allow to include/exclude site pages from processing by corresponding markup minifier or compressor. These properties are of type IList<IUrlMatcher>, and by default contains the empty lists, i.e. by default filtering is disabled.

There are 3 built-in implementations of IUrlMatcher interface:

1. ExactUrlMatcher. As a pattern used the URL (e.g., new ExactUrlMatcher("/contact")).
2. RegexUrlMatcher. As a pattern used a ECMAScript standard compliant regular expression (e.g., new RegexUrlMatcher(@"^/minifiers/x(?:ht)?ml-minifier$")).
3. WildcardUrlMatcher. Used a pattern, that supports Wildcard syntax (e.g., new WildcardUrlMatcher("/minifiers/x*ml-minifier")). This syntax supports 2 special characters: * (match any number of any characters) and ? (match exactly one character).

By default all of the above implementations of IUrlMatcher interface during matching is not case-sensitive. To change this behavior you need to pass to constructor of class as the second parameter value equals to true (e.g., new ExactUrlMatcher("/Contact", true)).

Starting with version 2.4.0, by default, only the GET requests are minified and compressed. You can change this behavior by using the SupportedHttpMethods property:

….SupportedHttpMethods = new HashSet<string> { "GET", "POST" };

HtmlMinificationManager and HtmlMinificationOptions classes have the following common properties:

XhtmlMinificationManager and XhtmlMinificationOptions classes have the following common properties:

XmlMinificationManager and XmlMinificationOptions classes have the following common properties:

HttpCompressionManager and HttpCompressionOptions classes have the following common properties:

HttpCompressionManager class is responsible for compression of text content by using GZip or Deflate algorithm. Decision about which algorithm to use depends on the value of Accept-Encoding HTTP header. If browser supports both algorithms, then preference is given to algorithm, which is higher in the list (value of CompressorFactories property).

In principle, you have the possibility to use other compression algorithms. To do this, you need to write your own implementations of the ICompressor and ICompressorFactory interfaces. After that add an instance of the implemented factory to top of the list, which is defined in CompressorFactories property. For example, there is a module, that adds support for the Brotli algorithm in ASP.NET extensions - WebMarkupMin.AspNet.Brotli.