Sign inDemoInstall


Package Overview
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies



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

Version published
Weekly downloads
decreased by-17.59%
Install size
9.47 MB
Weekly downloads

Package description

What is html-minifier-terser?

The html-minifier-terser npm package is a tool to minify HTML files. It removes unnecessary whitespace, comments, and other unneeded characters without changing the functionality of the HTML. This results in smaller file sizes which can lead to faster page load times. It is a fork of the original html-minifier package, updated to use Terser for JavaScript minification, which supports ES6+ syntax.

What are html-minifier-terser's main functionalities?

Minify HTML

This feature collapses whitespace between tags in the HTML, resulting in a smaller file size.

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

Remove Comments

This feature removes HTML comments from the file, which are not needed for functionality and can reduce file size.

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

Minify JavaScript

This feature minifies any JavaScript within <script> tags in the HTML, using Terser for advanced JavaScript minification.

const htmlMinifier = require('html-minifier-terser');
const result = htmlMinifier.minify('<script>var a = 1; var b = 2; var c = a + b;</script>', { minifyJS: true });
console.log(result); // Output: '<script>var a=1,b=2,c=a+b;</script>'

Minify CSS

This feature minifies any CSS within <style> tags or style attributes in the HTML.

const htmlMinifier = require('html-minifier-terser');
const result = htmlMinifier.minify('<style>body { font-size: 20px; color: #000000; }</style>', { minifyCSS: true });
console.log(result); // Output: '<style>body{font-size:20px;color:#000}</style>'

Remove Optional Tags

This feature removes optional closing tags like </head>, </body>, and sometimes <html> to further reduce the file size.

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

Other packages similar to html-minifier-terser




NPM version Build Status

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


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


Note that almost all options are disabled by default. Experiment and find what works best for you and your project.

For command line usage please see html-minifier-terser --help for a list of available options.

Sample command line:

html-minifier-terser --collapse-whitespace --remove-comments --minify-js true


const { minify } = require('html-minifier-terser');

const result = await minify('<p title="blah" id="moo">foo</p>', {
  removeAttributeQuotes: true,
result; // '<p title=blah id=moo>foo</p>'

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

Also see corresponding Ruby wrapper, and for Node.js, Grunt plugin, Gulp plugin, 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 and minimize?

SiteOriginal size (KB)HTMLMinifierminimizeWill
Stack Overflow177143154154n/a
Bootstrap CSS271260269229n/a
Eloquent Javascript870815840864n/a
New York Times1731158317261680n/a
ES draft629655385733n/an/a

Options Quick Reference

Most of the options are disabled by default.

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[ /^!/, /^\s*#/ ]
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 Terser)false (could be true, Object, Function(text, inline))
minifyURLsMinify URLs in various attributes (uses relateurl)false (could be String, Object, Function(text))
noNewlinesBeforeTagCloseNever add a newline before a tag that closes an elementfalse
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 -->.

Minifying JSON-LD

You can minify script tags with JSON-LD by setting the option { processScripts: ['application/ld+json'] }. Note that this minification is very rudimentary, it is mainly useful for removing newlines and excessive whitespace.

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.

Running benchmarks

Benchmarks for minified HTML:

cd benchmarks
npm install
npm run benchmark

Running local server

npm run serve



Last updated on 11 Apr 2023

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.


Related posts

SocketSocket SOC 2 Logo


  • 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