minify_html 0.2.5 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e8c15c45061862bc53a2f8b0c533162a7c01fc431265dcd96304c5b693e3413
-  data.tar.gz: 96ae5973cece926b066e04849e3d3a79e72ad9d32abf43cb4564a8daee987cb0
+  metadata.gz: b00d960a09c6d4de6681e685eb99b36d696cb8858b18a0654fabedf80b382a69
+  data.tar.gz: bcc1185949fccb475dcc7635a9426d54b4f7edff5cb3a27cae824c6da456dc68
 SHA512:
-  metadata.gz: c3bbc7c6adcd0a5f434c210e22f8c61d1c0a112bc66cea15a5987feabb78c7f1486cb25b8da5db4763ae93db302bd6979eb4dae00ed598fab29438c138898dd7
-  data.tar.gz: c97c0610c695c66622ab5e03ee56de1aa69e37dd9ef7f9731d030d7ba379bf6232e714a11380311684056c71ee3c5aee61250cca5a19f5927fa2da32129a8bcb
+  metadata.gz: aa9f76653e9059242cb57d4dba063c108ea9d710d465b1196f21e578c7a6c2b321b8c23fa9fc068eee5f3a9710be069bbe3d2722040469dcda49a9742a2240dc
+  data.tar.gz: e600314828a8b2a0f29a4412fbc4cf7e3fcceb4c22b842019f4f638a16e76e5d8fa3da2bb6700cc04e76cf1cd2dceb336500f0bfb324eb73c6384ec1e99e4bca

data/README.md

@@ -1,37 +1,29 @@
 # minify-html
 
-A fast one-pass in-place HTML minifier written in Rust with context-aware whitespace handling.
+An HTML minifier meticulously optimised for both speed and effectiveness, available for Rust, Node.js, Python, Java, and Ruby.
 
-Also supports JS minification by plugging into [esbuild](https://github.com/evanw/esbuild).
-
-Available as:
-- CLI for macOS and Linux.
-- Rust library.
-- Native library for Node.js, Python, Java, and Ruby.
-
-## Features
-
-- Minification is done in one pass with no backtracking or DOM/AST building.
-- No extra heap memory is allocated during processing, which increases performance.
-- Context-aware whitespace handling allows maximum minification while retaining desired spaces.
+- 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).
+- Natively binds to [esbuild](https://github.com/wilsonzlin/esbuild-rs) for super fast JS minification.
 
 ## Performance
 
-Speed and effectiveness of Node.js version compared to [html-minfier](https://github.com/kangax/html-minifier) and [minimize](https://github.com/Swaagie/minimize), run on popular already-minified web pages. See [bench](./bench) folder for more details.
+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="435" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.2.5/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.2.5/average-sizes.png">
+<img width="415" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.3.3/js/average-speeds.png"> <img width="415" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.3.3/js/average-sizes.png">
 
 ## Usage
 
 ### CLI
 
-Precompiled binaries are available for x86-64 macOS and Linux.
+Precompiled binaries are available for x86-64 Linux, macOS, and Windows.
 
 ##### Get
 
-[macOS](https://wilsonl.in/minify-html/bin/0.2.5-macos-x86_64) |
-[Linux](https://wilsonl.in/minify-html/bin/0.2.5-linux-x86_64)
+[Linux](https://wilsonl.in/minify-html/bin/0.3.3-linux-x86_64) |
+[macOS](https://wilsonl.in/minify-html/bin/0.3.3-macos-x86_64) |
+[Windows](https://wilsonl.in/minify-html/bin/0.3.3-windows-x86_64.exe)
 
 ##### Use
 
@@ -50,7 +42,7 @@ minify-html --src /path/to/src.html --out /path/to/output.min.html
 
 ```toml
 [dependencies]
-minify-html = { version = "0.2.5", features = ["js-esbuild"] }
+minify-html = { version = "0.3.3", features = ["js-esbuild"] }
 ```
 
 Building with the `js-esbuild` feature requires the Go compiler to be installed as well, to build the [JS minifier](https://github.com/evanw/esbuild).
@@ -60,7 +52,7 @@ If the `js-esbuild` feature is not enabled, `cfg.minify_js` will have no effect.
 ##### Use
 
 ```rust
-use minify_html::{Cfg, FriendlyError, in_place, copy, with_friendly_error, truncate};
+use minify_html::{Cfg, Error, FriendlyError, in_place, copy, with_friendly_error, truncate};
 
 fn main() {
     let mut code = b"<p>  Hello, world!  </p>".to_vec();
@@ -72,21 +64,21 @@ fn main() {
     // but leaves any original code after the minified code intact.
     match in_place(&mut code, cfg) {
         Ok(minified_len) => {}
-        Err((error_type, error_position)) => {}
+        Err(Error { error_type, position }) => {}
     };
 
     // Creates a vector copy containing only minified code
     // instead of minifying in-place.
     match copy(&code, cfg) {
         Ok(minified) => {}
-        Err((error_type, error_position)) => {}
+        Err(Error { error_type, position }) => {}
     };
 
     // Minifies a vector in-place, and then truncates the
     // vector to the new minified length.
     match truncate(&mut code, cfg) {
         Ok(()) => {}
-        Err((error_type, error_position)) => {}
+        Err(Error { error_type, position }) => {}
     };
 
     // Identical to `in_place` except with FriendlyError instead.
@@ -108,46 +100,48 @@ fn main() {
 <details>
 <summary><strong>Node.js</strong></summary>
 
-Package: [@minify-html/js-esbuild](https://www.npmjs.com/package/@minify-html/js-esbuild),
-Binding: [Neon](https://neon-bindings.com/)
-Platforms: macOS, Linux; Node.js 8 and higher
+- 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
 
 ##### Get
 
 Using npm:
 
 ```bash
-npm i @minify-html/js-esbuild
+npm i @minify-html/js
 ```
 
 Using Yarn:
 
 ```bash
-yarn add @minify-html/js-esbuild
+yarn add @minify-html/js
 ```
 
 ##### Use
 
 ```js
-const minifyHtml = require("@minify-html/js-esbuild");
+const minifyHtml = require("@minify-html/js");
 
-const cfg = { minifyJs: false };
+const cfg = minifyHtml.createConfiguration({ minifyJs: 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>", cfg);
-minifyHtml.minifyInPlace(source);
+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:
 
 ```ts
-import * as minifyHtml from "@minify-html/js-esbuild";
+import * as minifyHtml from "@minify-html/js";
 import * as fs from "fs";
 
-const cfg = { minifyJs: false };
+const cfg = minifyHtml.createConfiguration({ minifyJs: false });
 const minified = minifyHtml.minify("<p>  Hello, world!  </p>", cfg);
-minifyHtml.minifyInPlace(fs.readFileSync("source.html"), cfg);
+// Or alternatively:
+const minified = minifyHtml.minifyInPlace(fs.readFileSync("source.html"), cfg);
 ```
 
 </details>
@@ -155,9 +149,9 @@ minifyHtml.minifyInPlace(fs.readFileSync("source.html"), cfg);
 <details>
 <summary><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: macOS, Linux; Java 7 and higher
+- 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
 
@@ -167,14 +161,14 @@ Add as a Maven dependency:
 <dependency>
   <groupId>in.wilsonl.minifyhtml</groupId>
   <artifactId>minify-html</artifactId>
-  <version>0.2.5</version>
+  <version>0.3.3</version>
 </dependency>
 ```
 
 ##### Use
 
 ```java
-import in.wilsonl.minify_html.MinifyHtml;
+import in.wilsonl.minifyhtml.MinifyHtml;
 
 MinifyHtml.Configuration cfg = new MinifyHtml.Configuration.Builder()
     .setMinifyJs(false)
@@ -195,9 +189,9 @@ MinifyHtml.minifyInPlace(source, cfg);
 <details>
 <summary><strong>Python</strong></summary>
 
-Package: [minify_html](https://pypi.org/project/minify_html)
-Binding: [PyO3](https://github.com/PyO3/pyo3)
-Platforms: macOS, Linux; CPython 3.5 and higher
+- Package: [minify-html](https://pypi.org/project/minify-html)
+- Binding: [PyO3](https://github.com/PyO3/pyo3)
+- Platforms: Linux, macOS, Windows; Python 3.5 and higher
 
 ##### Get
 
@@ -219,9 +213,9 @@ except SyntaxError as e:
 <details>
 <summary><strong>Ruby</strong></summary>
 
-Package: [minify_html](https://rubygems.org/gems/minify_html)
-Binding: [Rutie](https://github.com/danielpclark/rutie)
-Platforms: macOS, Linux; Ruby 2.5 and higher
+- 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
 
@@ -455,6 +449,7 @@ Spaces are removed between attributes if possible.
 ### Entities
 
 Entities are decoded if valid (see relevant parsing section) and their decoded characters as UTF-8 is shorter or equal in length.
+Some entities are longer decoded than encoded, so they're left 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).
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minify_html
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.3
 platform: ruby
 authors:
 - Wilson Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-11 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiddle
@@ -62,5 +62,5 @@ rubyforge_project:
 rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: Fast allocation-less HTML minifier with smart whitespace handling
+summary: Fast and smart HTML + JS minifier
 test_files: []