Package: hyperbuild
hyperbuildA fast one-pass in-place HTML minifier written in Rust with context-aware whitespace handling.Also supports JS minification by plugging intoesbuild.Available as:CLI for macOS and Linux.Rust library.Native library for Node.js, Python, Java, and Ruby.FeaturesMinification is done in one pass with no backtracking or DOM/AST building.No extra heap memory is allocated during processing, which increases performance.Context-aware whitespace handling allows maximum minification while retaining desired spaces.Well tested with a large test suite and extensivefuzzing.PerformanceSpeed and effectiveness of Node.js version compared tohtml-minfierandminimize, run on popular already-minified web pages. Seebenchfolder for more details.UsageCLIPrecompiled binaries are available for x86-64 macOS and Linux.GetmacOS|LinuxUseUse the--helpargument for more details.hyperbuild--src/path/to/src.html--out/path/to/output.min.htmlAPIRustGet[dependencies]hyperbuild={version="0.2.4",features=["js-esbuild"]}Building with thejs-esbuildfeature requires the Go compiler to be installed as well, to build theJS minifier.If thejs-esbuildfeature is not enabled,cfg.minify_jswill have no effect.Useusehyperbuild::{Cfg,FriendlyError,hyperbuild,hyperbuild_copy,hyperbuild_friendly_error,hyperbuild_truncate};fnmain(){letmutcode=b"<p>  Hello, world!  </p>".to_vec();letcfg=&Cfg{minify_js:false,};// Minifies a slice in-place and returns the new minified length,// but leaves any original code after the minified code intact.matchhyperbuild(&mutcode,cfg){Ok(minified_len)=>{}Err((error_type,error_position))=>{}};// Creates a vector copy containing only minified code// instead of minifying in-place.matchhyperbuild_copy(&code,cfg){Ok(minified)=>{}Err((error_type,error_position))=>{}};// Minifies a vector in-place, and then truncates the// vector to the new minified length.matchhyperbuild_truncate(&mutcode,cfg){Ok(())=>{}Err((error_type,error_position))=>{}};// Identical to `hyperbuild` except with FriendlyError instead.// `code_context` is a string of a visual representation of the source,// with line numbers and position markers to aid in debugging syntax.matchhyperbuild_friendly_error(&mutcode,cfg){Ok(minified_len)=>{}Err(FriendlyError{position,message,code_context})=>{eprintln!("Failed at character {}:",position);eprintln!("{}",message);eprintln!("{}",code_context);}};}Node.jshyperbuild ison npm, available as aNode.js native module, and supports Node.js versions 8 and higher.GetUsing npm:npmihyperbuildUsing Yarn:yarnaddhyperbuildUseconsthyperbuild=require("hyperbuild");constcfg={minifyJs:false};constminified=hyperbuild.minify("<p>  Hello, world!  </p>",cfg);// Alternatively, minify in place to avoid copying.constsource=Buffer.from("<p>  Hello, world!  </p>",cfg);hyperbuild.minifyInPlace(source);hyperbuild is also available for TypeScript:import*ashyperbuildfrom"hyperbuild";import*asfsfrom"fs";constcfg={minifyJs:false};constminified=hyperbuild.minify("<p>  Hello, world!  </p>",cfg);hyperbuild.minifyInPlace(fs.readFileSync("source.html"),cfg);Javahyperbuild is available viaJNI, and supports Java versions 7 and higher.GetAdd as a Maven dependency:<dependency><groupId>in.wilsonl.hyperbuild</groupId><artifactId>hyperbuild</artifactId><version>0.2.4</version></dependency>Useimportin.wilsonl.hyperbuild.Hyperbuild;Hyperbuild.Configurationcfg=newHyperbuild.Configuration.Builder().setMinifyJs(false).build();try{Stringminified=Hyperbuild.minify("<p>  Hello, world!  </p>",cfg);}catch(Hyperbuild.SyntaxExceptione){System.err.println(e.getMessage());}// Alternatively, minify in place:assertsourceinstanceofByteBuffer&&source.isDirect();Hyperbuild.minifyInPlace(source,cfg);Pythonhyperbuild ison PyPI, available as anative module, and supports CPython (the default Python interpreter) versions 3.5 and higher.GetAdd the PyPI project as a dependency and install it usingpiporpipenv.Useimporthyperbuildtry:minified=hyperbuild.minify("<p>  Hello, world!  </p>",minify_js=False)exceptSyntaxErrorase:print(e)Rubyhyperbuild is published onRubyGems, available as anative modulefor macOS and Linux, and supports Ruby versions 2.5 and higher.GetAdd the library as a dependency toGemfileor*.gemspec.Userequire'hyperbuild'printHyperbuild.minify("<p>  Hello, world!  </p>",{:minify_js=>false})MinificationWhitespacehyperbuild has advanced context-aware whitespace minification that does things such as:Leave whitespace untouched inpreandcode, which are whitespace sensitive.Trim and collapse whitespace in content tags, as whitespace is collapsed anyway when rendered.Remove whitespace in layout tags, which allows the use of inline layouts while keeping formatted code.MethodsThere are three whitespace minification methods. When processing text content, hyperbuild chooses which ones to use depending on the containing element.Collapse whitespaceApplies to:any element exceptwhitespace sensitiveelements.Reduce a sequence of whitespace characters in text nodes to a single space (U+0020).BeforeAfter<p>↵
··The·quick·brown·fox↵
··jumps·over·the·lazy↵
··dog.↵</p><p>·The·quick·brown·fox·jumps·over·the·lazy·dog.·</p>Destroy whole whitespaceApplies to:any element exceptwhitespace sensitive,content,content-first, andformattingelements.Remove any text nodes between tags that only consist of whitespace characters.BeforeAfter<ul>↵
··<li>A</li>↵
··<li>B</li>↵
··<li>C</li>↵</ul><ul>↵
··<li>A</li><li>B</li><li>C</li>↵</ul>Trim whitespaceApplies to:any element exceptwhitespace sensitiveandformattingelements.Remove any leading/trailing whitespace from any leading/trailing text nodes of a tag.BeforeAfter<p>↵
··Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup>↵</p><p>Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup></p>Element typeshyperbuild recognises elements based on one of a few ways it assumes they are used. By making these assumptions, it can apply optimal whitespace minification strategies.GroupElementsExpected childrenFormattinga,strong,and othersFormatting elements, text.Contenth1,p,and othersFormatting elements, text.Layoutdiv,ul,and othersLayout elements, content elements.Content-firstlabel,li,and othersLike content but could be layout with only one child.Formatting elementsWhitespace is collapsed.Formatting elements are usually inline elements that wrap around part of some text in a content element, so its whitespace isn't trimmed as they're probably part of the content.Content elementsWhitespace is trimmed and collapsed.Content elements usually represent a contiguous and complete unit of content such as a paragraph. As such, whitespace is significant but sequences of them are most likely due to formatting.Before<p>↵
··Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup>↵</p>After<p>Hey,·I·<em>just</em>·found·out·about·this·<strong>cool</strong>·website!·<sup>[1]</sup></p>Layout elementsWhitespace is trimmed and collapsed. Whole whitespace is removed.These elements should only contain other elements and no text. This makes it possible to remove whole whitespace, which is useful when usingdisplay: inline-blockso that whitespace between elements (e.g. indentation) does not alter layout and styling.Before<ul>↵
··<li>A</li>↵
··<li>B</li>↵
··<li>C</li>↵</ul>After<ul><li>A</li><li>B</li><li>C</li></ul>Content-first elementsWhitespace is trimmed and collapsed.These elements are usually like content elements but are occasionally used like a layout element with one child. Whole whitespace is not removed as it might contain content, but this is OK for using as layout as there is only one child and whitespace is trimmed.Before<li>↵
··<article>↵
····<section></section>↵
····<section></section>↵
··</article>↵</li>After<li><article><section></section><section></section></article></li>TagsOptional closing tagsare removed.AttributesAny entities in attribute values are decoded, and then the shortest representation of the value is calculated and used:Double quoted, with any"encoded.Single quoted, with any'encoded.Unquoted, with"/'first character (if applicable),>last character (if applicable), and any whitespace encoded.classanddattributes have their whitespace (after any decoding) trimmed and collapsed.Boolean attributevalues are removed.Some other attributesare completely removed if their value is empty or the default value after any processing.typeattributes onscripttags with a value equaling aJavaScript MIME typeare removed.If an attribute value is empty after any processing, everything but the name is completely removed (i.e. no=), as an empty attribute is implicitlythe sameas an attribute with an empty string value.Spaces are removed between attributes if possible.EntitiesEntities are decoded if valid (see relevant parsing section) and their decoded characters as UTF-8 is shorter or equal in length.Numeric entities that do not refer to a validUnicode Scalar Valueare replaced with thereplacement character.If an entity is unintentionally formed after decoding, the leading ampersand is encoded, e.g.&&#97;&#109;&#112;;becomes&ampamp;. This is done as&ampis equal to or shorter than all other entity representations of characters part of an entity ([&#a-zA-Z0-9;]), and there is no other conflicting entity name that starts withamp.It's possible to get an unintentional entity after removing comments, e.g.&am<!-- -->p.Left chevrons after any decoding in text are encoded to&LTif possible or&LT;otherwise.CommentsComments are removed.IgnoredBangs,processing instructions, and empty elements are not removed as it is assumed there is a special reason for their declaration.ParsingOnly UTF-8/ASCII-encoded HTML code is supported.hyperbuild does no syntax checking or standards enforcement for performance and code complexity reasons.For example, this means that it's not an error to have self-closing tags, declare multiple<body>elements, use incorrect attribute names and values, or write something like<br>alert('');</br>However, there are some syntax requirements for speed and sanity.TagsTag names are case sensitive. For example, this means thatPwon't be recognised as a content element,bRwon't be considered as a void tag, and the contents ofScriptwon't be parsed as JavaScript.Tags must not beomitted. Void tags must not have a separate closing tag e.g.</input>.EntitiesWell-formed entities are decoded, including in attribute values.They are interpreted as characters representing their decoded value. This means that&#9;is considered a whitespace character and could be minified.Malformed entities are interpreted literally as a sequence of characters.If a named entity is an invalid reference as per thespecification, it is considered malformed.Numeric character references that do not reference a validUnicode Scalar Valueare considered malformed.AttributesBackticks (`) are not valid quote marks and not interpreted as such.
However, backticks are valid attribute value quotes in Internet Explorer.Special handling of some attributes require case sensitive names and values. For example,CLASSwon't be recognised as an attribute to minify, andtype="Text/JavaScript"on a<script>will not be removed.Script and stylescriptandstyletags must be closed with</script>and</style>respectively (case sensitive).hyperbuild doesnothandleescaped and double-escapedscript content.Issues and contributionsPull requests and any contributions welcome!If hyperbuild did something unexpected, misunderstood some syntax, or incorrectly kept/removed some code,raise an issuewith some relevant code that can be used to reproduce and investigate the issue.