DanielRuf/html-minifier-terser


actively maintained fork of html-minifier - minify HTML, CSS and JS code using terser - supports ES6 code

https://danielruf.github.io/html-minifier-terser

License: MIT

Language: JavaScript

Keywords: cli, compress, ecmascript6, es6, minify, terser, uglify, uglify-js, uglifyjs


HTMLMinifier

NPM version Build Status Dependency Status

HTMLMinifier is a highly configurable, well-tested, JavaScript-based HTML minifier.

See corresponding blog post for all the gory details of how it works, description of each option, testing results and conclusions.

Test suite is available online.

Also see corresponding Ruby wrapper, and for Node.js, Grunt plugin, Gulp module, Koa middleware wrapper and Express middleware wrapper.

For lint-like capabilities take a look at HTMLLint.

Minification comparison

How does HTMLMinifier compare to other solutions — HTML Minifier from Will Peavy (1st result in Google search for "html minifier") as well as htmlcompressor.com and minimize?

Site Original size (KB) HTMLMinifier minimize Will Peavy htmlcompressor.com
Google 45 41 45 46 45
Stack Overflow 115 82 90 92 88
HTMLMinifier 132 105 118 123 118
Bootstrap CSS 271 260 269 229 269
Twitter 289 238 282 314 282
BBC 298 233 289 291 269
Wikipedia 574 468 557 578 557
Amazon 702 343 692 704 n/a
NBC 844 805 843 844 n/a
Eloquent Javascript 870 815 840 864 n/a
New York Times 1304 1183 1301 1295 n/a
ES draft 6347 5686 5863 n/a n/a

Options Quick Reference

Most of the options are disabled by default.

Option Description Default
caseSensitive Treat attributes in case sensitive manner (useful for custom HTML tags) false
collapseBooleanAttributes Omit attribute values from boolean attributes false
collapseInlineTagWhitespace Don't leave any spaces between display:inline; elements when collapsing. Must be used in conjunction with collapseWhitespace=true false
collapseWhitespace Collapse white space that contributes to text nodes in a document tree false
conservativeCollapse Always collapse to 1 space (never remove it entirely). Must be used in conjunction with collapseWhitespace=true false
continueOnParseError Handle parse errors instead of aborting. false
customAttrAssign Arrays of regex'es that allow to support custom attribute assign expressions (e.g. '<div flex?="{{mode != cover}}"></div>') [ ]
customAttrCollapse Regex that specifies custom attribute to strip newlines from (e.g. /ng-class/)
customAttrSurround Arrays of regex'es that allow to support custom attribute surround expressions (e.g. <input {{#if value}}checked="checked"{{/if}}>) [ ]
customEventAttributes Arrays of regex'es that allow to support custom event attributes for minifyJS (e.g. ng-click) [ /^on[a-z]{3,}$/ ]
decodeEntities Use direct Unicode characters whenever possible false
html5 Parse input according to HTML5 specifications true
ignoreCustomComments Array of regex'es that allow to ignore certain comments, when matched [ /^!/ ]
ignoreCustomFragments Array of regex'es that allow to ignore certain fragments, when matched (e.g. <?php ... ?>, {{ ... }}, etc.) [ /<%[\s\S]*?%>/, /<\?[\s\S]*?\?>/ ]
includeAutoGeneratedTags Insert tags generated by HTML parser true
keepClosingSlash Keep the trailing slash on singleton elements false
maxLineLength Specify a maximum line length. Compressed output will be split by newlines at valid HTML split-points
minifyCSS Minify CSS in style elements and style attributes (uses clean-css) false (could be true, Object, Function(text, type))
minifyJS Minify JavaScript in script elements and event attributes (uses Terser) false (could be true, Object, Function(text, inline))
minifyURLs Minify URLs in various attributes (uses relateurl) false (could be String, Object, Function(text))
preserveLineBreaks Always collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break. Must be used in conjunction with collapseWhitespace=true false
preventAttributesEscaping Prevents the escaping of the values of attributes false
processConditionalComments Process contents of conditional comments through minifier false
processScripts Array of strings corresponding to types of script elements to process through minifier (e.g. text/ng-template, text/x-handlebars-template, etc.) [ ]
quoteCharacter Type of quote to use for attribute values (' or ")
removeAttributeQuotes Remove quotes around attributes when possible false
removeComments Strip HTML comments false
removeEmptyAttributes Remove all attributes with whitespace-only values false (could be true, Function(attrName, tag))
removeEmptyElements Remove all elements with empty contents false
removeOptionalTags Remove optional tags false
removeRedundantAttributes Remove attributes when value matches default. false
removeScriptTypeAttributes Remove type="text/javascript" from script tags. Other type attribute values are left intact false
removeStyleLinkTypeAttributes Remove type="text/css" from style and link tags. Other type attribute values are left intact false
removeTagWhitespace Remove space between attributes whenever possible. Note that this will result in invalid HTML! false
sortAttributes Sort attributes by frequency false
sortClassName Sort style classes by frequency false
trimCustomFragments Trim white space around ignoreCustomFragments. false
useShortDoctype Replaces the doctype with the short (HTML5) doctype false

Sorting attributes / style classes

Minifier options like sortAttributes and sortClassName won't impact the plain-text size of the output. However, they form long repetitive chains of characters that should improve compression ratio of gzip used in HTTP compression.

Special cases

Ignoring chunks of markup

If you have chunks of markup you would like preserved, you can wrap them <!-- htmlmin:ignore -->.

Preserving SVG tags

SVG tags are automatically recognized, and when they are minified, both case-sensitivity and closing-slashes are preserved, regardless of the minification settings used for the rest of the file.

Working with invalid markup

HTMLMinifier can't work with invalid or partial chunks of markup. This is because it parses markup into a tree structure, then modifies it (removing anything that was specified for removal, ignoring anything that was specified to be ignored, etc.), then it creates a markup out of that tree and returns it.

Input markup (e.g. <p id="">foo)

Internal representation of markup in a form of tree (e.g. { tag: "p", attr: "id", children: ["foo"] })

Transformation of internal representation (e.g. removal of id attribute)

Output of resulting markup (e.g. <p>foo</p>)

HTMLMinifier can't know that original markup was only half of the tree; it does its best to try to parse it as a full tree and it loses information about tree being malformed or partial in the beginning. As a result, it can't create a partial/malformed tree at the time of the output.

Installation Instructions

From NPM for use as a command line app:

npm install html-minifier-terser -g

From NPM for programmatic use:

npm install html-minifier-terser

From Git:

git clone git://github.com/DanielRuf/html-minifier-terser.git
cd html-minifier-terser
npm link .

Usage

Note that almost all options are disabled by default. For command line usage please see html-minifier-terser --help for a list of available options. Experiment and find what works best for you and your project.

  • Sample command line: html-minifier-terser --collapse-whitespace --remove-comments --remove-optional-tags --remove-redundant-attributes --remove-script-type-attributes --remove-tag-whitespace --use-short-doctype --minify-css true --minify-js true

Node.js

var minify = require('html-minifier-terser').minify;
var result = minify('<p title="blah" id="moo">foo</p>', {
  removeAttributeQuotes: true
});
result; // '<p title=blah id=moo>foo</p>'

Running benchmarks

Benchmarks for minified HTML:

node benchmark.js

Project Statistics

Sourcerank 12
Repository Size 10.7 MB
Stars 43
Forks 5
Watchers 4
Open issues 18
Dependencies 511
Contributors 78
Tags 112
Created
Last updated
Last pushed

Top Contributors See all

Alex Lam S.L. Juriy Zaytsev XhmikosR Duncan Beevers Daniel Ruf Laurent Goderre Michael Hulse Zoltan Mathias Bynens Andreas Lind Rafał Pocztarski Steven Vachon stereobooster stieler-it Bryan Rayner Tom Byrer Nikola Kotur Jacob will Farrell silverwind

Packages Referencing this Repo

org.webjars.npm:html-minifier-terser
WebJar for html-minifier-terser
Latest release 5.1.1 - Published - 43 stars
html-minifier-terser
Highly configurable, well-tested, JavaScript-based HTML minifier.
Latest release 5.1.1 - Updated - 43 stars

Recent Tags See all

v5.1.1 May 13, 2020
v5.1.0 April 29, 2020
v5.0.5 March 23, 2020
v5.0.4 February 19, 2020
v5.0.3 February 09, 2020
v5.0.2 November 12, 2019
v5.0.1 November 03, 2019
v5.0.0 November 02, 2019
v4.0.0 April 01, 2019
v4.0.0 April 01, 2019
v3.5.21 October 25, 2018
v3.6.0 October 24, 2018
v3.5.20 August 19, 2018
v3.5.19 July 13, 2018
v3.5.19 July 13, 2018

Something wrong with this page? Make a suggestion

Last synced: 2019-11-12 08:49:04 UTC

Login to resync this repository