hyperbuild 0.1.10 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e556f9c7d4088da60101da67f3122a1383a492b53dfabd14a72527bf58bf64a
-  data.tar.gz: ae64306255bb1345ffe29abeaaf8ea36472f2a88e23651de6299413fa59d7f7f
+  metadata.gz: e83b0423aee5805c928eaea74b59e6b230bd5445b96bc7d01de4de3d851c6651
+  data.tar.gz: e095ae3c16b327a8712a0ff049f4908ddf7ce3292a128f516933c00c2d455d8a
 SHA512:
-  metadata.gz: 00071f629c3e0b8586e109baeb540008bf40fa3d0876efca0a30c7da612bdd9fb1f7f80abd31f82a8432fa8bb573aa7ad750c2f9328ead6e0186ac10681227ed
-  data.tar.gz: 0ed32c3233e1500458759b4ad0dfca11949c34823fb76f88127e1691ae4ffd156738a62f15d0735dc28f7bd65e0d7a6c0eb51277e9e52d8188c5c7e305c35843
+  metadata.gz: d9adcacde88b2985ae0488ea1555c6c83ac376492cd21c2316fa3130176ccce17c11c75f2d7ed30f94c03bd1454bc117221dc63523e45c69d305aa2fb562803f
+  data.tar.gz: d19a164fc4709d8448408f54d417d62df4bd5bcf7eda5d90296c987c350ce1611dec530a23dffc6915bf19f63550bbd88e6bea73df8446b079f43382ff27338f

data/README.md

@@ -2,8 +2,10 @@
 
 A fast one-pass in-place HTML minifier written in Rust with context-aware whitespace handling.
 
+Also supports JS minification by plugging into [esbuild](https://github.com/evanw/esbuild).
+
 Available as:
-- CLI for Windows, macOS, and Linux.
+- CLI for macOS and Linux.
 - Rust library.
 - Native library for Node.js, Python, Java, and Ruby.
 
@@ -12,27 +14,29 @@ Available as:
 - 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.
+- Well tested with a large test suite and extensive [fuzzing](./fuzz).
 
 ## 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.
 
-<img width="435" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.1.10/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.1.10/average-sizes.png">
+<img width="435" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.2.4/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.2.4/average-sizes.png">
 
 ## Usage
 
 ### CLI
 
-Precompiled binaries are available for x86-64 Windows, macOS, and Linux.
+Precompiled binaries are available for x86-64 macOS and Linux.
 
 ##### Get
 
-[Windows](https://wilsonl.in/hyperbuild/bin/0.1.10-windows-x86_64.exe) |
-[macOS](https://wilsonl.in/hyperbuild/bin/0.1.10-macos-x86_64) |
-[Linux](https://wilsonl.in/hyperbuild/bin/0.1.10-linux-x86_64)
+[macOS](https://wilsonl.in/hyperbuild/bin/0.2.4-macos-x86_64) |
+[Linux](https://wilsonl.in/hyperbuild/bin/0.2.4-linux-x86_64)
 
 ##### Use
 
+Use the `--help` argument for more details.
+
 ```bash
 hyperbuild --src /path/to/src.html --out /path/to/output.min.html
 ```
@@ -46,34 +50,41 @@ hyperbuild --src /path/to/src.html --out /path/to/output.min.html
 
 ```toml
 [dependencies]
-hyperbuild = "0.1.10"
+hyperbuild = { version = "0.2.4", 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).
+
+If the `js-esbuild` feature is not enabled, `cfg.minify_js` will have no effect.
+
 ##### Use
 
 ```rust
-use hyperbuild::{FriendlyError, hyperbuild};
+use hyperbuild::{Cfg, FriendlyError, hyperbuild, hyperbuild_copy, hyperbuild_friendly_error, hyperbuild_truncate};
 
 fn main() {
     let mut code = b"<p>  Hello, world!  </p>".to_vec();
+    let cfg = &Cfg {
+        minify_js: false,
+    };
 
     // Minifies a slice in-place and returns the new minified length,
     // but leaves any original code after the minified code intact.
-    match hyperbuild(&mut code) {
+    match hyperbuild(&mut code, cfg) {
         Ok(minified_len) => {}
         Err((error_type, error_position)) => {}
     };
 
     // Creates a vector copy containing only minified code
     // instead of minifying in-place.
-    match hyperbuild_copy(&code) {
+    match hyperbuild_copy(&code, cfg) {
         Ok(minified) => {}
         Err((error_type, error_position)) => {}
     };
 
     // Minifies a vector in-place, and then truncates the
     // vector to the new minified length.
-    match hyperbuild_truncate(&mut code) {
+    match hyperbuild_truncate(&mut code, cfg) {
         Ok(()) => {}
         Err((error_type, error_position)) => {}
     };
@@ -81,7 +92,7 @@ fn main() {
     // Identical to `hyperbuild` except with FriendlyError instead.
     // `code_context` is a string of a visual representation of the source,
     // with line numbers and position markers to aid in debugging syntax.
-    match hyperbuild_friendly_error(&mut code) {
+    match hyperbuild_friendly_error(&mut code, cfg) {
         Ok(minified_len) => {}
         Err(FriendlyError { position, message, code_context }) => {
             eprintln!("Failed at character {}:", position);
@@ -118,10 +129,11 @@ yarn add hyperbuild
 ```js
 const hyperbuild = require("hyperbuild");
 
-const minified = hyperbuild.minify("<p>  Hello, world!  </p>");
+const cfg = { minifyJs: false };
+const minified = hyperbuild.minify("<p>  Hello, world!  </p>", cfg);
 
 // Alternatively, minify in place to avoid copying.
-const source = Buffer.from("<p>  Hello, world!  </p>");
+const source = Buffer.from("<p>  Hello, world!  </p>", cfg);
 hyperbuild.minifyInPlace(source);
 ```
 
@@ -131,8 +143,9 @@ hyperbuild is also available for TypeScript:
 import * as hyperbuild from "hyperbuild";
 import * as fs from "fs";
 
-const minified = hyperbuild.minify("<p>  Hello, world!  </p>");
-hyperbuild.minifyInPlace(fs.readFileSync("source.html"));
+const cfg = { minifyJs: false };
+const minified = hyperbuild.minify("<p>  Hello, world!  </p>", cfg);
+hyperbuild.minifyInPlace(fs.readFileSync("source.html"), cfg);
 ```
 
 </details>
@@ -150,7 +163,7 @@ Add as a Maven dependency:
 <dependency>
   <groupId>in.wilsonl.hyperbuild</groupId>
   <artifactId>hyperbuild</artifactId>
-  <version>0.1.10</version>
+  <version>0.2.4</version>
 </dependency>
 ```
 
@@ -159,15 +172,18 @@ Add as a Maven dependency:
 ```java
 import in.wilsonl.hyperbuild.Hyperbuild;
 
+Hyperbuild.Configuration cfg = new Hyperbuild.Configuration.Builder()
+    .setMinifyJs(false)
+    .build();
 try {
-    String minified = Hyperbuild.minify("<p>  Hello, world!  </p>");
+    String minified = Hyperbuild.minify("<p>  Hello, world!  </p>", cfg);
 } catch (Hyperbuild.SyntaxException e) {
     System.err.println(e.getMessage());
 }
 
 // Alternatively, minify in place:
 assert source instanceof ByteBuffer && source.isDirect();
-Hyperbuild.minifyInPlace(source);
+Hyperbuild.minifyInPlace(source, cfg);
 ```
 
 </details>
@@ -187,7 +203,7 @@ Add the PyPI project as a dependency and install it using `pip` or `pipenv`.
 import hyperbuild
 
 try:
-    minified = hyperbuild.minify("<p>  Hello, world!  </p>")
+    minified = hyperbuild.minify("<p>  Hello, world!  </p>", minify_js=False)
 except SyntaxError as e:
     print(e)
 ```
@@ -208,17 +224,13 @@ Add the library as a dependency to `Gemfile` or `*.gemspec`.
 ```ruby
 require 'hyperbuild'
 
-print Hyperbuild.minify "<p>  Hello, world!  </p>"
+print Hyperbuild.minify("<p>  Hello, world!  </p>", { :minify_js => false })
 ```
 
 </details>
 
 ## Minification
 
-### Configurability
-
-Configuration of minification is currently WIP across all languages. The behaviour mentioned below is the default.
-
 ### Whitespace
 
 hyperbuild has advanced context-aware whitespace minification that does things such as:
@@ -440,6 +452,8 @@ Numeric entities that do not refer to a valid [Unicode Scalar Value](https://www
 
 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`.
 
+It's possible to get an unintentional entity after removing comments, e.g. `&am<!-- -->p`.
+
 Left chevrons after any decoding in text are encoded to `&LT` if possible or `&LT;` otherwise.
 
 ### Comments
@@ -454,7 +468,7 @@ Bangs, [processing instructions](https://en.wikipedia.org/wiki/Processing_Instru
 
 Only UTF-8/ASCII-encoded HTML code is supported.
 
-hyperbuild simply does HTML minification, and almost does no syntax checking or standards enforcement for performance and code complexity reasons.
+hyperbuild does no syntax checking or standards enforcement for performance and code complexity reasons.
 
 For example, this means that it's not an error to have self-closing tags, declare multiple `<body>` elements, use incorrect attribute names and values, or write something like `<br>alert('');</br>`
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperbuild
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.4
 platform: ruby
 authors:
 - Wilson Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiddle
@@ -62,6 +62,5 @@ rubyforge_project:
 rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: Fast one-pass in-place HTML minifier written in Rust with context-aware whitespace
-  handling
+summary: Fast allocation-less HTML minifier with smart whitespace handling
 test_files: []