minify_html 0.4.11 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df6e29c73642fae171bfe86ef03db760defe1222b8ca121d7376eb709a56887
-  data.tar.gz: 97d43726d7fb4debbc02c6037e0498d7dc870124243fb5e117a7cdc72540f9f4
+  metadata.gz: b345a814633290c8d04adfd8c4092cd57a2ebf620917b034a2bfb53ff290daa9
+  data.tar.gz: f7326e86591fb55e4cf95afecb867c6176bde562ea37cee12ef3d430e22bcd33
 SHA512:
-  metadata.gz: 8ba0748e70593ea8176bb06a0f5c7ef2aae355a6b746cec2b3d26efb962cb9b68cb7057d607d51d4a4288c82a85a87093edef82ca1b842c3dc8a9fdca3e37c8d
-  data.tar.gz: 6159738839535b2351a9cf4545b8ef2d9fbea189cc640b4f261a227ae125c0d841f33e2d42a13811b34d23d3287595eb8e97edf733ee7efb59c300ba3820b6c7
+  metadata.gz: cc3b5e11f8e3815d49ee894cf3554267d225262fcc1e16065a29bd9039cb21eed907edc3f21ac2cdd8b7b2c957d9716834ef57566c5cfb0b1110c6062c22682c
+  data.tar.gz: 85c2986b16a7aea1b58f49719e70d687c5a4ea49a41d742969439f8ca6a5986f48b5d6a96d771c59431bde8786690b714a1c862a95b95fa5d595348b37038448

data/README.md

@@ -1,32 +1,42 @@
-# minify-html
-
-An HTML minifier meticulously optimised for both speed and effectiveness written in Rust.
-Comes with native bindings to Node.js, Python, Java, and Ruby.
-
-- Advanced minification strategy beats other minifiers with only one pass.
-- Uses zero memory allocations, SIMD searching, direct tries, and lookup tables.
-- Well tested with a large test suite and extensive [fuzzing](./fuzz).
+<h1>
+minify-html
+<img width="24" src="./icon/cli.png">
+<img width="24" src="./icon/java.png">
+<img width="24" src="./icon/nodejs.png">
+<img width="24" src="./icon/python.png">
+<img width="24" src="./icon/ruby.png">
+<img width="24" src="./icon/rust.png">
+</h1>
+
+An HTML minifier meticulously optimised for both speed and effectiveness, written in Rust.
+
+- Advanced minification strategy beats other minifiers while being much faster.
+- Uses SIMD searching, direct tries, and lookup tables.
+- Handles [invalid HTML](./notes/Parsing.md), with extensive testing and [fuzzing](./fuzz).
 - Natively binds to [esbuild](https://github.com/wilsonzlin/esbuild-rs) for super fast JS and CSS minification.
 
 ## Performance
 
 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)
 
-<img width="415" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.4.11/core/average-speeds.png"> <img width="415" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.4.11/core/average-sizes.png">
+<img width="415" alt="Chart showing speed and compression of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.5.0/core/average-combined.png">
+
+Need even faster performance? Check the [one](https://github.com/wilsonzlin/minify-html/tree/one) branch.
 
 ## Usage
 
-### CLI
+<details>
+<summary><img width="24" src="./icon/cli.png"> <strong>CLI</strong></summary>
 
 Precompiled binaries are available for x86-64 Linux, macOS, and Windows.
 
-##### Get
+### Get
 
-[Linux](https://wilsonl.in/minify-html/bin/0.4.11-linux-x86_64) |
-[macOS](https://wilsonl.in/minify-html/bin/0.4.11-macos-x86_64) |
-[Windows](https://wilsonl.in/minify-html/bin/0.4.11-windows-x86_64.exe)
+[Linux](https://wilsonl.in/minify-html/bin/0.5.0-linux-x86_64) |
+[macOS](https://wilsonl.in/minify-html/bin/0.5.0-macos-x86_64) |
+[Windows](https://wilsonl.in/minify-html/bin/0.5.0-windows-x86_64.exe)
 
-##### Use
+### Use
 
 Use the `--help` argument for more details.
 
@@ -34,36 +44,36 @@ Use the `--help` argument for more details.
 minify-html --src /path/to/src.html --out /path/to/output.min.html --css --js
 ```
 
-### API
+</details>
 
 <details>
-<summary><strong>Rust</strong></summary>
+<summary><img width="24" src="./icon/rust.png"> <strong>Rust</strong></summary>
 
-##### Get
+### Get
 
 ```toml
 [dependencies]
-minify-html = { version = "0.4.11", features = ["js-esbuild"] }
+minify-html = { version = "0.5.0", features = ["js-esbuild"] }
 ```
 
 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).
 
 If the `js-esbuild` feature is not enabled, `cfg.minify_js` and `cfg.minify_css` will have no effect.
 
-##### Use
+### Use
 
 Check out the [docs](https://docs.rs/minify-html) for API and usage examples.
 
 </details>
 
 <details>
-<summary><strong>Node.js</strong></summary>
+<summary><img width="24" src="./icon/nodejs.png"> <strong>Node.js</strong></summary>
 
 - Package: [@minify-html/js](https://www.npmjs.com/package/@minify-html/js)
 - Binding: [N-API](https://nodejs.org/api/n-api.html)
-- Platforms: Linux, macOS, Windows; Node.js 8.6.0 and higher
+- Platforms: Linux (ARM64 and x86-64), macOS (x86-64), Windows (x86-64); Node.js 8.6.0 and higher
 
-##### Get
+### Get
 
 Using npm:
 
@@ -77,18 +87,14 @@ Using Yarn:
 yarn add @minify-html/js
 ```
 
-##### Use
+### Use
 
 ```js
 const minifyHtml = require("@minify-html/js");
 
-const cfg = minifyHtml.createConfiguration({ minifyJs: false, minifyCss: false });
+// Refer to TypeScript definitions for details.
+const cfg = minifyHtml.createConfiguration({ minify_js: false, minify_css: false });
 const minified = minifyHtml.minify("<p>  Hello, world!  </p>", cfg);
-
-// Alternatively, minify in place to avoid copying.
-const source = Buffer.from("<p>  Hello, world!  </p>");
-// This is a Buffer representing a slice of `source`, not newly allocated memory.
-const minified = minifyHtml.minifyInPlace(source, cfg);
 ```
 
 minify-html is also available for TypeScript:
@@ -97,22 +103,20 @@ minify-html is also available for TypeScript:
 import * as minifyHtml from "@minify-html/js";
 import * as fs from "fs";
 
-const cfg = minifyHtml.createConfiguration({ minifyJs: false, minifyCss: false });
+const cfg = minifyHtml.createConfiguration({ minify_js: false, minify_css: false });
 const minified = minifyHtml.minify("<p>  Hello, world!  </p>", cfg);
-// Or alternatively:
-const minified = minifyHtml.minifyInPlace(fs.readFileSync("source.html"), cfg);
 ```
 
 </details>
 
 <details>
-<summary><strong>Java</strong></summary>
+<summary><img width="24" src="./icon/java.png"> <strong>Java</strong></summary>
 
 - Package: [in.wilsonl.minifyhtml](https://search.maven.org/artifact/in.wilsonl.minifyhtml/minify-html)
 - Binding: [JNI](https://github.com/jni-rs/jni-rs)
 - Platforms: Linux, macOS, Windows; Java 7 and higher
 
-##### Get
+### Get
 
 Add as a Maven dependency:
 
@@ -120,11 +124,11 @@ Add as a Maven dependency:
 <dependency>
   <groupId>in.wilsonl.minifyhtml</groupId>
   <artifactId>minify-html</artifactId>
-  <version>0.4.11</version>
+  <version>0.5.0</version>
 </dependency>
 ```
 
-##### Use
+### Use
 
 ```java
 import in.wilsonl.minifyhtml.Configuration;
@@ -136,55 +140,44 @@ Configuration cfg = new Configuration.Builder()
     .setMinifyCss(false)
     .build();
 
-try {
-    String minified = MinifyHtml.minify("<p>  Hello, world!  </p>", cfg);
-} catch (SyntaxException e) {
-    System.err.println(e.getMessage());
-}
-
-// Alternatively, minify in place:
-assert source instanceof ByteBuffer && source.isDirect();
-MinifyHtml.minifyInPlace(source, cfg);
+String minified = MinifyHtml.minify("<p>  Hello, world!  </p>", cfg);
 ```
 
 </details>
 
 <details>
-<summary><strong>Python</strong></summary>
+<summary><img width="24" src="./icon/python.png"> <strong>Python</strong></summary>
 
 - Package: [minify-html](https://pypi.org/project/minify-html)
 - Binding: [PyO3](https://github.com/PyO3/pyo3)
 - Platforms: Linux, macOS, Windows; Python 3.7 and higher
 
-##### Get
+### Get
 
 Add the PyPI project as a dependency and install it using `pip` or `pipenv`.
 
-##### Use
+### Use
 
 ```python
 import minify_html
 
-try:
-    minified = minify_html.minify("<p>  Hello, world!  </p>", minify_js=False, minify_css=False)
-except SyntaxError as e:
-    print(e)
+minified = minify_html.minify("<p>  Hello, world!  </p>", minify_js=False, minify_css=False)
 ```
 
 </details>
 
 <details>
-<summary><strong>Ruby</strong></summary>
+<summary><img width="24" src="./icon/ruby.png"> <strong>Ruby</strong></summary>
 
 - Package: [minify_html](https://rubygems.org/gems/minify_html)
 - Binding: [Rutie](https://github.com/danielpclark/rutie)
 - Platforms: Linux, macOS; Ruby 2.5 and higher
 
-##### Get
+### Get
 
 Add the library as a dependency to `Gemfile` or `*.gemspec`.
 
-##### Use
+### Use
 
 ```ruby
 require 'minify_html'
@@ -196,7 +189,7 @@ print MinifyHtml.minify("<p>  Hello, world!  </p>", { :minify_js => false, :mini
 
 ## Minification
 
-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.
+Note that some 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. These can be turned off via the Cfg object.
 
 ### Whitespace
 
@@ -413,14 +406,12 @@ Spaces are removed between attributes if possible.
 
 ### Entities
 
-Entities are decoded if they're valid and shorter or equal in length when decoded.
+Entities are decoded if they're valid and shorter or equal in length when decoded. UTF-8 sequences that have a shorter entity representation are encoded.
 
 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).
 
 If an entity is unintentionally formed after decoding, the leading ampersand is encoded, e.g. `&&#97;&#109;&#112;;` becomes `&ampamp;`. This is done as `&amp` 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`.
 
-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.
-
 ### Comments
 
 Comments are removed.
@@ -431,9 +422,7 @@ Bangs, [processing instructions](https://en.wikipedia.org/wiki/Processing_Instru
 
 ## Parsing
 
-- 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.
+minify-html can process any HTML, handling all possible syntax (including invalid ones) gracefully like browsers. See [Parsing.md](./notes/Parsing.md) for more details.  
 
 ## Issues and contributions
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minify_html
 version: !ruby/object:Gem::Version
-  version: 0.4.11
+  version: 0.5.0
 platform: ruby
 authors:
 - Wilson Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiddle