npmpackage.info

Gathering detailed insights and metrics for html-minifier

Other packages similar to html-minifier

@types/html-minifier-terser

7.0.2

TypeScript definitions for html-minifier-terser

html-minifier-terser

7.2.0

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

@types/html-minifier

4.0.5

TypeScript definitions for html-minifier

htmlnano

2.1.1

Modular HTML minifier, built on top of the PostHTML

Gathering detailed insights and metrics for html-minifier

html-minifier

Javascript-based HTML compressor/minifier (with Node.js support)

4.0.0

4,946

MIT

JavaScript

1,307,676,177 3.7

Installations

npm install html-minifier

Score

97.1

Supply Chain

98.6

Quality

79.6

Maintenance

Vulnerability

100

License

Pull Requests

Open

23

Total

392

Closed

65

Merged

304

Issues

Open

82

Total

756

Closed

674

Releases

4.0.0

v4.0.0

Published on 01 Apr 2019

3.5.20

v3.5.20

Published on 19 Aug 2018

3.5.19

v3.5.19

Published on 13 Jul 2018

3.5.18

v3.5.18

Published on 03 Jul 2018

3.5.17

v3.5.17

Published on 25 Jun 2018

3.5.16

v3.5.16

Published on 20 May 2018

View all 52 releases

Developer

kangax

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=6

Typescript Support

No

Node Version

10.15.3

NPM Version

6.4.1 Statistics

4,946 Stars

1,291 Commits

571 Forks

100 Watching

4 Branches

87 Contributors

Updated on 25 Nov 2024

Languages

JavaScript (94.89%)

HTML (4.58%)

CSS (0.54%)

Total Downloads

Cumulative downloads

Total Downloads

1,307,676,177

Last day

-7.7%

575,046

Compared to previous day

Last week

1.2%

3,082,097

Compared to previous week

Last month

20.2%

12,572,965

Compared to previous month

Last year

-15.9%

138,634,248

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

camel-case clean-css commander he param-case relateurl uglify-js

Dev Dependencies

grunt grunt-browserify grunt-contrib-uglify grunt-eslint phantomjs-prebuilt qunit

Versions

HTMLMinifier

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	46	42	46	48	46
HTMLMinifier	125	98	111	117	111
Twitter	207	165	200	224	200
Stack Overflow	253	195	207	215	204
Bootstrap CSS	271	260	269	228	269
BBC	298	239	290	291	280
Amazon	422	316	412	425	n/a
NBC	553	530	552	553	534
Wikipedia	565	461	548	569	548
New York Times	678	606	675	670	n/a
Eloquent Javascript	870	815	840	864	n/a
ES6 table	5911	5051	5595	n/a	n/a
ES draft	6126	5495	5664	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 UglifyJS)	`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 .

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:

1npm install html-minifier -g

From NPM for programmatic use:

1npm install html-minifier

From Git:

1git clone git://github.com/kangax/html-minifier.git
2cd html-minifier
3npm 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

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

Gulp

1const { src, dest, series } = require('gulp');
2const htmlMinify = require('html-minifier');
3
4const options = {
5  includeAutoGeneratedTags: true,
6  removeAttributeQuotes: true,
7  removeComments: true,
8  removeRedundantAttributes: true,
9  removeScriptTypeAttributes: true,
10  removeStyleLinkTypeAttributes: true,
11  sortClassName: true,
12  useShortDoctype: true,
13  collapseWhitespace: true
14};
15
16function html() {
17  return src('app/**/*.html')
18    .on('data', function(file) {
19      const buferFile = Buffer.from(htmlMinify.minify(file.contents.toString(), options))
20      return file.contents = buferFile
21    })
22    .pipe(dest('build'))
23}
24
25exports.html = series(html)

Running benchmarks

Benchmarks for minified HTML:

1node benchmark.js

Stable Version

The latest stable version of the package.

Stable Version

4.0.0

HIGH

7.5/10

Summary

kangax html-minifier REDoS vulnerability

Affected Versions

<= 4.0.0

Patched Versions

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More