Socket
Socket
Sign inDemoInstall

html-minifier

Package Overview
Dependencies
11
Maintainers
3
Versions
80
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

html-minifier

Highly configurable, well-tested, JavaScript-based HTML minifier.


Version published
Maintainers
3
Weekly downloads
2,722,294
decreased by-7.51%

Weekly downloads

Package description

What is html-minifier?

The html-minifier npm package is a highly configurable, well-tested, JavaScript-based HTML minifier, with lint-like capabilities. It compresses HTML files by removing unnecessary whitespace, comments, and other unneeded characters without changing the functionality of the HTML. This can result in faster page load times and reduced bandwidth usage.

What are html-minifier's main functionalities?

Minify HTML

This feature collapses whitespace and strips out unnecessary spaces and line breaks to minimize the HTML file size.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<p>      Some HTML     </p>', {collapseWhitespace: true});
console.log(result); // Output: '<p>Some HTML</p>'

Remove Comments

This feature removes HTML comments to reduce the file size.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<!-- This is a comment --> <div>Content</div>', {removeComments: true});
console.log(result); // Output: '<div>Content</div>'

Remove Optional Tags

This feature removes optional tags like <html>, <head>, <body>, and <colgroup> when they are not necessary.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<html><head><title>Title</title></head><body><p>Content</p></body></html>', {removeOptionalTags: true});
console.log(result); // Output: '<title>Title</title><p>Content</p>'

Minify CSS

This feature minifies inline CSS reducing its size by removing unnecessary characters and whitespace.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<style>    .class { font-size: 18px; }    </style>', {minifyCSS: true});
console.log(result); // Output: '<style>.class{font-size:18px}</style>'

Minify JavaScript

This feature minifies inline JavaScript code by removing unnecessary characters and whitespace.

const htmlMinifier = require('html-minifier').minify;
let result = htmlMinifier('<script>    var name = "Your Name";    </script>', {minifyJS: true});
console.log(result); // Output: '<script>var name="Your Name";</script>'

Other packages similar to html-minifier

Readme

Source

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?

SiteOriginal size (KB)HTMLMinifierminimizeWill Peavyhtmlcompressor.com
Google4642464846
HTMLMinifier12598111117111
Twitter207165200224200
Stack Overflow253195207215204
Bootstrap CSS271260269228269
BBC298239290291280
Amazon422316412425n/a
NBC553530552553534
Wikipedia565461548569548
New York Times678606675670n/a
Eloquent Javascript870815840864n/a
ES6 table591150515595n/an/a
ES draft612654955664n/an/a

Options Quick Reference

Most of the options are disabled by default.

OptionDescriptionDefault
caseSensitiveTreat attributes in case sensitive manner (useful for custom HTML tags)false
collapseBooleanAttributesOmit attribute values from boolean attributesfalse
collapseInlineTagWhitespaceDon't leave any spaces between display:inline; elements when collapsing. Must be used in conjunction with collapseWhitespace=truefalse
collapseWhitespaceCollapse white space that contributes to text nodes in a document treefalse
conservativeCollapseAlways collapse to 1 space (never remove it entirely). Must be used in conjunction with collapseWhitespace=truefalse
continueOnParseErrorHandle parse errors instead of aborting.false
customAttrAssignArrays of regex'es that allow to support custom attribute assign expressions (e.g. '<div flex?="{{mode != cover}}"></div>')[ ]
customAttrCollapseRegex that specifies custom attribute to strip newlines from (e.g. /ng-class/)
customAttrSurroundArrays of regex'es that allow to support custom attribute surround expressions (e.g. <input {{#if value}}checked="checked"{{/if}}>)[ ]
customEventAttributesArrays of regex'es that allow to support custom event attributes for minifyJS (e.g. ng-click)[ /^on[a-z]{3,}$/ ]
decodeEntitiesUse direct Unicode characters whenever possiblefalse
html5Parse input according to HTML5 specificationstrue
ignoreCustomCommentsArray of regex'es that allow to ignore certain comments, when matched[ /^!/ ]
ignoreCustomFragmentsArray of regex'es that allow to ignore certain fragments, when matched (e.g. <?php ... ?>, {{ ... }}, etc.)[ /<%[\s\S]*?%>/, /<\?[\s\S]*?\?>/ ]
includeAutoGeneratedTagsInsert tags generated by HTML parsertrue
keepClosingSlashKeep the trailing slash on singleton elementsfalse
maxLineLengthSpecify a maximum line length. Compressed output will be split by newlines at valid HTML split-points
minifyCSSMinify CSS in style elements and style attributes (uses clean-css)false (could be true, Object, Function(text, type))
minifyJSMinify JavaScript in script elements and event attributes (uses UglifyJS)false (could be true, Object, Function(text, inline))
minifyURLsMinify URLs in various attributes (uses relateurl)false (could be String, Object, Function(text))
preserveLineBreaksAlways collapse to 1 line break (never remove it entirely) when whitespace between tags include a line break. Must be used in conjunction with collapseWhitespace=truefalse
preventAttributesEscapingPrevents the escaping of the values of attributesfalse
processConditionalCommentsProcess contents of conditional comments through minifierfalse
processScriptsArray of strings corresponding to types of script elements to process through minifier (e.g. text/ng-template, text/x-handlebars-template, etc.)[ ]
quoteCharacterType of quote to use for attribute values (' or ")
removeAttributeQuotesRemove quotes around attributes when possiblefalse
removeCommentsStrip HTML commentsfalse
removeEmptyAttributesRemove all attributes with whitespace-only valuesfalse (could be true, Function(attrName, tag))
removeEmptyElementsRemove all elements with empty contentsfalse
removeOptionalTagsRemove optional tagsfalse
removeRedundantAttributesRemove attributes when value matches default.false
removeScriptTypeAttributesRemove type="text/javascript" from script tags. Other type attribute values are left intactfalse
removeStyleLinkTypeAttributesRemove type="text/css" from style and link tags. Other type attribute values are left intactfalse
removeTagWhitespaceRemove space between attributes whenever possible. Note that this will result in invalid HTML!false
sortAttributesSort attributes by frequencyfalse
sortClassNameSort style classes by frequencyfalse
trimCustomFragmentsTrim white space around ignoreCustomFragments.false
useShortDoctypeReplaces the doctype with the short (HTML5) doctypefalse

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

From NPM for programmatic use:

npm install html-minifier

From Git:

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

Usage

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

  • Sample command line: html-minifier --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').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

Keywords

FAQs

Last updated on 01 Apr 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc