2020-07-11 11:29:34 -04:00
# minify-html
2018-06-30 06:37:24 -04:00
2020-09-20 06:50:22 -04:00
An HTML minifier meticulously optimised for both speed and effectiveness written in Rust.
Comes with native bindings to Node.js, Python, Java, and Ruby.
2018-10-25 07:54:54 -04:00
2020-07-13 11:00:51 -04:00
- Advanced minification strategy beats other minifiers with only one pass.
- Uses zero memory allocations, SIMD searching, direct tries, and lookup tables.
2020-07-10 07:00:52 -04:00
- Well tested with a large test suite and extensive [fuzzing ](./fuzz ).
2021-01-07 08:26:02 -05:00
- Natively binds to [esbuild ](https://github.com/wilsonzlin/esbuild-rs ) for super fast JS and CSS minification.
2018-06-30 06:37:24 -04:00
2020-01-01 09:18:38 -05:00
## Performance
2020-07-17 10:58:20 -04:00
Comparison with [html-minfier ](https://github.com/kangax/html-minifier ) and [minimize ](https://github.com/Swaagie/minimize ), run on the top web pages. [See the breakdown here. ](./bench )
2020-01-12 01:42:30 -05:00
2021-04-06 04:43:07 -04:00
< img width = "415" alt = "Chart showing speed of HTML minifiers" src = "https://wilsonl.in/minify-html/bench/0.4.4/core/average-speeds.png" > < img width = "415" alt = "Chart showing effectiveness of HTML minifiers" src = "https://wilsonl.in/minify-html/bench/0.4.4/core/average-sizes.png" >
2020-01-01 09:18:38 -05:00
2019-04-29 10:09:51 -04:00
## Usage
2018-06-30 06:37:24 -04:00
2019-12-29 19:52:45 -05:00
### CLI
2020-07-22 07:52:54 -04:00
Precompiled binaries are available for x86-64 Linux, macOS, and Windows.
2020-01-31 08:18:43 -05:00
2020-01-26 04:50:27 -05:00
##### Get
2020-01-26 01:08:43 -05:00
2021-04-06 04:43:07 -04:00
[Linux ](https://wilsonl.in/minify-html/bin/0.4.4-linux-x86_64 ) |
[macOS ](https://wilsonl.in/minify-html/bin/0.4.4-macos-x86_64 ) |
[Windows ](https://wilsonl.in/minify-html/bin/0.4.4-windows-x86_64.exe )
2020-01-01 04:47:49 -05:00
##### Use
2020-07-10 11:15:56 -04:00
Use the `--help` argument for more details.
2019-12-26 01:16:13 -05:00
```bash
2021-01-07 09:58:31 -05:00
minify-html --src /path/to/src.html --out /path/to/output.min.html --css --js
2019-12-26 01:16:13 -05:00
```
2018-08-07 22:31:28 -04:00
2019-12-29 19:52:45 -05:00
### API
2019-12-30 02:41:09 -05:00
< details >
< summary > < strong > Rust< / strong > < / summary >
##### Get
```toml
[dependencies]
2021-04-06 04:43:07 -04:00
minify-html = { version = "0.4.4", features = ["js-esbuild"] }
2019-12-30 02:41:09 -05:00
```
2021-01-07 08:26:02 -05:00
Building with the `js-esbuild` feature requires the Go compiler to be installed as well, to build the [JS and CSS minifier ](https://github.com/wilsonzlin/esbuild-rs ).
2020-07-11 09:25:36 -04:00
2021-01-07 08:26:02 -05:00
If the `js-esbuild` feature is not enabled, `cfg.minify_js` and `cfg.minify_css` will have no effect.
2020-07-11 09:25:36 -04:00
2019-12-30 02:41:09 -05:00
##### Use
2020-08-24 10:36:27 -04:00
Check out the [docs ](https://docs.rs/minify-html ) for API and usage examples.
2019-12-29 19:52:45 -05:00
2019-12-30 02:41:09 -05:00
< / details >
< details >
< summary > < strong > Node.js< / strong > < / summary >
2020-07-21 03:57:39 -04:00
- Package: [@minify-html/js ](https://www.npmjs.com/package/@minify-html/js )
2020-07-24 03:47:55 -04:00
- Binding: [N-API ](https://nodejs.org/api/n-api.html )
- Platforms: Linux, macOS, Windows; Node.js 8.6.0 and higher
2019-12-30 02:41:09 -05:00
##### Get
Using npm:
```bash
2020-07-21 03:57:39 -04:00
npm i @minify -html/js
2019-12-30 02:41:09 -05:00
```
Using Yarn:
```bash
2020-07-21 03:57:39 -04:00
yarn add @minify -html/js
2019-12-30 02:41:09 -05:00
```
##### Use
```js
2020-07-21 03:57:39 -04:00
const minifyHtml = require("@minify-html/js");
2019-12-30 02:41:09 -05:00
2021-01-07 08:26:02 -05:00
const cfg = minifyHtml.createConfiguration({ minifyJs: false, minifyCss: false });
2020-07-11 11:29:34 -04:00
const minified = minifyHtml.minify("< p > Hello, world! < / p > ", cfg);
2020-05-12 03:12:29 -04:00
// Alternatively, minify in place to avoid copying.
2020-07-14 19:48:09 -04:00
const source = Buffer.from("< p > Hello, world! < / p > ");
2020-07-14 19:51:45 -04:00
// This is a Buffer representing a slice of `source` , not newly allocated memory.
const minified = minifyHtml.minifyInPlace(source, cfg);
2019-12-30 02:41:09 -05:00
```
2020-07-11 11:29:34 -04:00
minify-html is also available for TypeScript:
2020-01-31 08:18:43 -05:00
```ts
2020-07-21 03:57:39 -04:00
import * as minifyHtml from "@minify-html/js";
2020-05-12 03:12:29 -04:00
import * as fs from "fs";
2020-01-31 08:18:43 -05:00
2021-01-07 08:26:02 -05:00
const cfg = minifyHtml.createConfiguration({ minifyJs: false, minifyCss: false });
2020-07-11 11:29:34 -04:00
const minified = minifyHtml.minify("< p > Hello, world! < / p > ", cfg);
2020-07-14 19:51:45 -04:00
// Or alternatively:
const minified = minifyHtml.minifyInPlace(fs.readFileSync("source.html"), cfg);
2020-01-31 08:18:43 -05:00
```
2019-12-30 02:41:09 -05:00
< / details >
2020-01-18 08:21:58 -05:00
< details >
< summary > < strong > Java< / strong > < / summary >
2020-07-12 00:52:14 -04:00
- Package: [in.wilsonl.minifyhtml ](https://search.maven.org/artifact/in.wilsonl.minifyhtml/minify-html )
- Binding: [JNI ](https://github.com/jni-rs/jni-rs )
2020-07-22 07:52:54 -04:00
- Platforms: Linux, macOS, Windows; Java 7 and higher
2020-01-18 08:21:58 -05:00
##### Get
2020-01-19 22:42:23 -05:00
Add as a Maven dependency:
```xml
< dependency >
2020-07-11 12:01:48 -04:00
< groupId > in.wilsonl.minifyhtml< / groupId >
2020-07-11 11:29:34 -04:00
< artifactId > minify-html< / artifactId >
2021-04-06 04:43:07 -04:00
< version > 0.4.4< / version >
2020-01-19 22:42:23 -05:00
< / dependency >
```
2020-01-18 08:21:58 -05:00
##### Use
```java
2020-08-26 00:46:01 -04:00
import in.wilsonl.minifyhtml.Configuration;
2020-07-12 01:07:46 -04:00
import in.wilsonl.minifyhtml.MinifyHtml;
2020-08-26 00:46:01 -04:00
import in.wilsonl.minifyhtml.SyntaxException;
2020-01-18 08:21:58 -05:00
2020-08-26 00:46:01 -04:00
Configuration cfg = new Configuration.Builder()
2020-07-10 11:15:56 -04:00
.setMinifyJs(false)
2021-01-07 08:26:02 -05:00
.setMinifyCss(false)
2020-07-10 11:15:56 -04:00
.build();
2020-08-26 00:46:01 -04:00
2020-05-12 03:12:29 -04:00
try {
2020-07-11 11:29:34 -04:00
String minified = MinifyHtml.minify("< p > Hello, world! < / p > ", cfg);
2020-08-26 00:46:01 -04:00
} catch (SyntaxException e) {
2020-05-12 03:12:29 -04:00
System.err.println(e.getMessage());
2020-01-18 08:21:58 -05:00
}
2020-05-12 03:12:29 -04:00
// Alternatively, minify in place:
assert source instanceof ByteBuffer & & source.isDirect();
2020-07-11 11:29:34 -04:00
MinifyHtml.minifyInPlace(source, cfg);
2020-01-18 08:21:58 -05:00
```
< / details >
2020-01-19 00:50:21 -05:00
< details >
2020-01-19 00:52:42 -05:00
< summary > < strong > Python< / strong > < / summary >
2020-01-19 00:50:21 -05:00
2020-07-12 01:04:07 -04:00
- Package: [minify-html ](https://pypi.org/project/minify-html )
2020-07-12 00:52:14 -04:00
- Binding: [PyO3 ](https://github.com/PyO3/pyo3 )
2021-01-06 02:03:01 -05:00
- Platforms: Linux, macOS, Windows; Python 3.7 and higher
2020-01-19 00:50:21 -05:00
##### Get
2020-01-20 05:57:31 -05:00
Add the PyPI project as a dependency and install it using `pip` or `pipenv` .
2020-01-19 00:50:21 -05:00
##### Use
2020-01-19 00:52:42 -05:00
```python
2020-07-11 11:29:34 -04:00
import minify_html
2020-01-19 00:50:21 -05:00
2020-05-12 03:12:29 -04:00
try:
2021-01-07 08:26:02 -05:00
minified = minify_html.minify("< p > Hello, world! < / p > ", minify_js=False, minify_css=False)
2020-05-12 03:12:29 -04:00
except SyntaxError as e:
print(e)
2020-01-19 00:50:21 -05:00
```
< / details >
2020-01-19 03:19:33 -05:00
< details >
< summary > < strong > Ruby< / strong > < / summary >
2020-07-12 00:52:14 -04:00
- Package: [minify_html ](https://rubygems.org/gems/minify_html )
- Binding: [Rutie ](https://github.com/danielpclark/rutie )
2020-07-22 07:52:54 -04:00
- Platforms: Linux, macOS; Ruby 2.5 and higher
2020-01-19 03:19:33 -05:00
##### Get
2020-01-19 22:42:23 -05:00
Add the library as a dependency to `Gemfile` or `*.gemspec` .
2020-01-19 03:19:33 -05:00
##### Use
```ruby
2020-07-11 11:29:34 -04:00
require 'minify_html'
2020-01-19 03:19:33 -05:00
2021-01-07 08:26:02 -05:00
print MinifyHtml.minify("< p > Hello, world! < / p > ", { :minify_js => false, :minify_css => false })
2020-01-19 03:19:33 -05:00
```
< / details >
2019-04-29 10:09:51 -04:00
## Minification
2018-07-02 05:21:00 -04:00
2021-04-06 05:32:49 -04:00
Note that many of the minification done can result in HTML that will not pass validation, but remain interpreted and rendered correctly by the browser; essentially, the laxness of the browser is taken advantage of for better minification.
2019-04-29 10:09:51 -04:00
### Whitespace
2018-06-30 06:37:24 -04:00
2020-07-11 11:29:34 -04:00
minify-html has advanced context-aware whitespace minification that does things such as:
2018-07-04 07:23:17 -04:00
2019-12-27 06:14:03 -05:00
- Leave whitespace untouched in `pre` and `code` , 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.
2019-12-28 01:15:23 -05:00
#### Methods
2020-07-11 11:29:34 -04:00
There are three whitespace minification methods. When processing text content, minify-html chooses which ones to use depending on the containing element.
2019-12-28 01:15:23 -05:00
< details >
2019-12-28 01:22:09 -05:00
< summary > < strong > Collapse whitespace< / strong > < / summary >
2019-12-28 01:15:23 -05:00
2020-01-17 03:27:34 -05:00
> **Applies to:** any element except [whitespace sensitive](./src/spec/tag/whitespace.rs) elements.
2019-12-27 19:58:01 -05:00
Reduce a sequence of whitespace characters in text nodes to a single space (U+0020).
< table > < thead > < tr > < th > Before< th > After< tbody > < tr > < td >
```html
< p > ↵
··The·quick·brown·fox↵
··jumps·over·the·lazy↵
··dog.↵
< / p >
```
< td >
```html
< p > ·The·quick·brown·fox·jumps·over·the·lazy·dog.·< / p >
```
< / table >
2019-12-28 01:15:23 -05:00
< / details >
2019-12-27 19:58:01 -05:00
2019-12-28 01:15:23 -05:00
< details >
2019-12-28 01:22:09 -05:00
< summary > < strong > Destroy whole whitespace< / strong > < / summary >
2019-12-28 01:15:23 -05:00
2020-01-17 03:27:34 -05:00
> **Applies to:** any element except [whitespace sensitive](./src/spec/tag/whitespace.rs), [content](src/spec/tag/whitespace.rs), [content-first](./src/spec/tag/whitespace.rs), and [formatting](./src/spec/tag/whitespace.rs) elements.
2019-12-27 19:58:01 -05:00
2020-05-12 03:12:29 -04:00
Remove any text nodes between tags that only consist of whitespace characters.
2019-12-27 19:58:01 -05:00
< table > < thead > < tr > < th > Before< th > After< tbody > < tr > < td >
```html
< ul > ↵
··< li > A< / li > ↵
··< li > B< / li > ↵
··< li > C< / li > ↵
< / ul >
```
< td >
```html
2019-12-28 01:15:23 -05:00
< ul > ↵
··< li > A< / li > < li > B< / li > < li > C< / li > ↵
< / ul >
2019-12-27 19:58:01 -05:00
```
< / table >
2019-12-28 01:15:23 -05:00
< / details >
2019-12-27 19:58:01 -05:00
2019-12-28 01:15:23 -05:00
< details >
2019-12-28 01:22:09 -05:00
< summary > < strong > Trim whitespace< / strong > < / summary >
2019-12-27 19:58:01 -05:00
2020-01-17 03:27:34 -05:00
> **Applies to:** any element except [whitespace sensitive](./src/spec/tag/whitespace.rs) and [formatting](./src/spec/tag/whitespace.rs) elements.
2019-12-27 19:58:01 -05:00
2019-12-28 01:15:23 -05:00
Remove any leading/trailing whitespace from any leading/trailing text nodes of a tag.
2019-12-27 19:58:01 -05:00
< table > < thead > < tr > < th > Before< th > After< tbody > < tr > < td >
```html
< p > ↵
··Hey,·I·< em > just< / em > ·found↵
··out·about·this·< strong > cool< / strong > ·website!↵
2019-12-28 01:15:23 -05:00
··< sup > [1]< / sup > ↵
2019-12-27 19:58:01 -05:00
< / p >
```
< td >
```html
< p > Hey,·I·< em > just< / em > ·found↵
··out·about·this·< strong > cool< / strong > ·website!↵
2019-12-28 01:15:23 -05:00
··< sup > [1]< / sup > < / p >
2019-12-27 19:58:01 -05:00
```
< / table >
2019-12-28 01:15:23 -05:00
< / details >
#### Element types
2020-07-11 11:29:34 -04:00
minify-html 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.
2019-12-28 01:15:23 -05:00
|Group|Elements|Expected children|
|---|---|---|
2020-01-17 03:27:34 -05:00
|Formatting|`a`, `strong` , [and others ](./src/spec/tag/whitespace.rs )|Formatting elements, text.|
|Content|`h1`, `p` , [and others ](src/spec/tag/whitespace.rs )|Formatting elements, text.|
|Layout|`div`, `ul` , [and others ](./src/spec/tag/whitespace.rs )|Layout elements, content elements.|
|Content-first|`label`, `li` , [and others ](./src/spec/tag/whitespace.rs )|Like content but could be layout with only one child.|
2019-12-28 01:15:23 -05:00
2019-12-28 01:17:42 -05:00
< details >
2019-12-28 01:22:09 -05:00
< summary > < strong > Formatting elements< / strong > < / summary >
2019-12-28 01:15:23 -05:00
> Whitespace 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.
2019-12-28 01:17:42 -05:00
< / details >
< details >
2019-12-28 01:22:09 -05:00
< summary > < strong > Content elements< / strong > < / summary >
2019-12-28 01:15:23 -05:00
> Whitespace 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
```html
< p > ↵
··Hey,·I·< em > just< / em > ·found↵
··out·about·this·< strong > cool< / strong > ·website!↵
··< sup > [1]< / sup > ↵
< / p >
```
###### After
```html
< p > Hey,·I·< em > just< / em > ·found·out·about·this·< strong > cool< / strong > ·website!·< sup > [1]< / sup > < / p >
```
2019-12-28 01:17:42 -05:00
< / details >
< details >
2019-12-28 01:22:09 -05:00
< summary > < strong > Layout elements< / strong > < / summary >
2019-12-28 01:15:23 -05:00
2019-12-28 01:21:13 -05:00
> Whitespace is trimmed and collapsed. Whole whitespace is removed.
2019-12-28 01:15:23 -05:00
2019-12-28 01:21:13 -05:00
These elements should only contain other elements and no text. This makes it possible to remove whole whitespace, which is useful when using `display: inline-block` so that whitespace between elements (e.g. indentation) does not alter layout and styling.
2019-12-28 01:15:23 -05:00
###### Before
```html
< ul > ↵
··< li > A< / li > ↵
··< li > B< / li > ↵
··< li > C< / li > ↵
< / ul >
```
###### After
```html
< ul > < li > A< / li > < li > B< / li > < li > C< / li > < / ul >
```
2019-12-28 01:17:42 -05:00
< / details >
< details >
2019-12-28 01:22:09 -05:00
< summary > < strong > Content-first elements< / strong > < / summary >
2019-12-28 01:15:23 -05:00
> Whitespace is trimmed and collapsed.
2019-12-28 01:21:13 -05:00
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.
2019-12-28 01:15:23 -05:00
###### Before
```html
< li > ↵
··< article > ↵
····< section > < / section > ↵
····< section > < / section > ↵
··< / article > ↵
< / li >
```
###### After
```html
< li > < article > < section > < / section > < section > < / section > < / article > < / li >
```
2019-12-27 19:58:01 -05:00
2019-12-28 01:17:42 -05:00
< / details >
2020-01-06 07:36:05 -05:00
### Tags
[Optional closing tags ](https://html.spec.whatwg.org/multipage/syntax.html#syntax-tag-omission ) are removed.
2019-12-27 06:14:03 -05:00
### Attributes
2020-01-04 22:07:31 -05:00
Any entities in attribute values are decoded, and then the shortest representation of the value is calculated and used:
2019-12-27 06:14:03 -05:00
- Double quoted, with any `"` encoded.
- Single quoted, with any `'` encoded.
2019-12-28 01:34:36 -05:00
- Unquoted, with `"` /`'` first character (if applicable), `>` last character (if applicable), and any whitespace encoded.
2019-12-27 06:14:03 -05:00
2020-01-25 09:32:41 -05:00
`class` and `d` attributes have their whitespace (after any decoding) trimmed and collapsed.
2020-01-04 22:07:31 -05:00
2020-01-19 07:31:22 -05:00
[Boolean attribute ](./gen/attrs.json ) values are removed.
2020-01-25 09:32:41 -05:00
[Some other attributes ](./gen/attrs.json ) are completely removed if their value is empty or the default value after any processing.
2020-01-07 08:38:42 -05:00
2020-01-14 08:58:33 -05:00
`type` attributes on `script` tags with a value equaling a [JavaScript MIME type ](https://mimesniff.spec.whatwg.org/#javascript-mime-type ) are removed.
2020-01-07 04:56:37 -05:00
2020-01-14 08:58:33 -05:00
If an attribute value is empty after any processing, everything but the name is completely removed (i.e. no `=` ), as an empty attribute is implicitly [the same ](https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 ) as an attribute with an empty string value.
2019-12-27 06:14:03 -05:00
Spaces are removed between attributes if possible.
2020-01-14 07:59:25 -05:00
### Entities
2019-12-27 06:14:03 -05:00
2020-07-30 00:38:40 -04:00
Entities are decoded if they're valid and shorter or equal in length when decoded.
2020-01-15 06:57:47 -05:00
2020-01-25 19:30:41 -05:00
Numeric entities that do not refer to a valid [Unicode Scalar Value ](https://www.unicode.org/glossary/#unicode_scalar_value ) are replaced with the [replacement character ](https://en.wikipedia.org/wiki/Specials_(Unicode_block )#Replacement_character ).
2020-01-31 08:18:43 -05:00
2020-01-14 08:58:33 -05:00
If an entity is unintentionally formed after decoding, the leading ampersand is encoded, e.g. `&amp;` becomes `&amp;` . This is done as `&` is 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 with `amp` .
2020-01-14 07:59:25 -05:00
2020-09-20 06:50:22 -04:00
Note that it's possible to get an unintentional entity after removing comments, e.g. `&am<!-- -->p` ; minify-html will **not** encode the leading ampersand.
2020-01-25 09:32:41 -05:00
2020-01-14 07:59:25 -05:00
### Comments
Comments are removed.
2019-12-27 06:14:03 -05:00
2019-12-27 19:16:28 -05:00
### Ignored
2019-12-27 06:14:03 -05:00
2020-01-08 07:00:23 -05:00
Bangs, [processing instructions ](https://en.wikipedia.org/wiki/Processing_Instruction ), and empty elements are not removed as it is assumed there is a special reason for their declaration.
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
## Parsing
2018-07-04 07:23:17 -04:00
2020-08-01 22:19:01 -04:00
- Input must be UTF-8.
- Opening tags must not be [omitted ](https://html.spec.whatwg.org/multipage/syntax.html#syntax-tag-omission ).
- [Escaped and double-escaped ](./notes/Script%20data.md ) script content are not supported.
2020-01-14 08:58:33 -05:00
## Issues and contributions
2020-01-25 09:45:34 -05:00
Pull requests and any contributions welcome!
2020-01-14 08:58:33 -05:00
2020-07-11 11:29:34 -04:00
If minify-html did something unexpected, misunderstood some syntax, or incorrectly kept/removed some code, [raise an issue ](https://github.com/wilsonzlin/minify-html/issues ) with some relevant code that can be used to reproduce and investigate the issue.