hyperbuild 0.0.39 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf76b6eba2f31e29ec7710592cc2c4fd352c7aa4e443a5628483063a9236275d
-  data.tar.gz: 852918eb82dc5156f6ca7a0daa39c900fd8fa3bdd71bf0f6382a7c484684401a
+  metadata.gz: 1caffe6030b630477a348d3ec79ff73b6f67b1abbab3caff22a7cba2252da378
+  data.tar.gz: 29c61e146de8f1ca6084879d6dbf50168fbc9cf7cd5019f22699df3a2f2bf751
 SHA512:
-  metadata.gz: 21e6b993e37b16f0e2e00176796d3a1cc6e413c93e760b38c96869b3787a725cf809e44188d7e9cc68654a700754986f93788dfbeacae9b7024fe18dbde0fa9e
-  data.tar.gz: 2d9eef71e0076b4a01a016cb4283c932fc61204bc8f4f89e981077076c01e7d69ed6d5607cce35a70bb19cb23c40126e20a8cf9751881bb70f1d09d856ee5beb
+  metadata.gz: 13bb7e4921171a136092018227b8b77a3d64599844c19cc7f6e835f9f47a3b5776660c49c13bffadbc68409b10fb7d6eb559f6c650f152d67f18e2650f1e9db2
+  data.tar.gz: 1e0b9c28914954a37a2dabc64544f876c7ab718408a8942d5aeff5781e4625002bb730e9707a768e5aca0f28b0fa9ca83397b5cb9b3154cfcf3c1b53b7d74941

data/README.md

@@ -15,19 +15,21 @@ Available as:
 
 ## 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). See [bench](./bench) folder for more details.
+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.0.39/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.0.39/average-sizes.png">
+<img width="435" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.1.1/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.1.1/average-sizes.png">
 
 ## Usage
 
 ### CLI
 
+Precompiled binaries are available for x86-64 Windows, macOS, and Linux.
+
 ##### Get
 
-[Windows](https://wilsonl.in/hyperbuild/bin/0.0.39-windows-x86_64.exe) |
-[macOS](https://wilsonl.in/hyperbuild/bin/0.0.39-macos-x86_64) |
-[Linux](https://wilsonl.in/hyperbuild/bin/0.0.39-linux-x86_64)
+[Windows](https://wilsonl.in/hyperbuild/bin/0.1.1-windows-x86_64.exe) |
+[macOS](https://wilsonl.in/hyperbuild/bin/0.1.1-macos-x86_64) |
+[Linux](https://wilsonl.in/hyperbuild/bin/0.1.1-linux-x86_64)
 
 ##### Use
 
@@ -44,7 +46,7 @@ hyperbuild --src /path/to/src.html --out /path/to/output.min.html
 
 ```toml
 [dependencies]
-hyperbuild = "0.0.39"
+hyperbuild = "0.1.1"
 ```
 
 ##### Use
@@ -54,9 +56,34 @@ use hyperbuild::hyperbuild;
 
 fn main() {
     let mut code = b"<p>  Hello, world!  </p>".to_vec();
+
+    // `hyperbuild` 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) {
         Ok(minified_len) => {}
-        Err((error_type, error_at_char_no)) => {}
+        Err((error_type, error_position)) => {}
+    };
+
+    // `hyperbuild_copy` creates a vector copy containing only minified code instead of minifying in-place.
+    match hyperbuild_copy(&code) {
+        Ok(minified) => {}
+        Err((error_type, error_position)) => {}
+    };
+
+    // `hyperbuild_truncate` minifies a vector in-place, and then truncates the vector to the new minified length.
+    match hyperbuild_truncate(&mut code) {
+        Ok(()) => {}
+        Err((error_type, error_position)) => {}
+    };
+
+    // `hyperbuild_friendly_error` is identical to `hyperbuild` except the error is a FriendlyError instead.
+    // `code_context` is a string of a visual representation of the source code with line numbers and position markers to aid in debugging syntax issues, and should be printed.
+    match hyperbuild_friendly_error(&mut code) {
+        Ok(minified_len) => {}
+        Err(FriendlyError { position, message, code_context }) => {
+            eprintln!("Failed at character {}:", position);
+            eprintln!("{}", message);
+            eprintln!("{}", code_context);
+        }
     };
 }
 ```
@@ -88,6 +115,20 @@ yarn add hyperbuild
 const hyperbuild = require("hyperbuild");
 
 const minified = hyperbuild.minify("<p>  Hello, world!  </p>");
+
+// Alternatively, minify in place to avoid copying.
+const source = Buffer.from("<p>  Hello, world!  </p>");
+hyperbuild.minifyInPlace(source);
+```
+
+hyperbuild is also available for TypeScript:
+
+```ts
+import * as hyperbuild from "hyperbuild";
+import * as fs from "fs";
+
+const minified = hyperbuild.minify("<p>  Hello, world!  </p>");
+hyperbuild.minifyInPlace(fs.readFileSync("source.html"));
 ```
 
 </details>
@@ -105,7 +146,7 @@ Add as a Maven dependency:
 <dependency>
   <groupId>in.wilsonl.hyperbuild</groupId>
   <artifactId>hyperbuild</artifactId>
-  <version>0.0.39</version>
+  <version>0.1.1</version>
 </dependency>
 ```
 
@@ -114,11 +155,15 @@ Add as a Maven dependency:
 ```java
 import in.wilsonl.hyperbuild.Hyperbuild;
 
-class Main {
-    public static void main(String[] args) {
-        String minified = Hyperbuild.minify("<p>  Hello, world!  </p>");
-    }
+try {
+    String minified = Hyperbuild.minify("<p>  Hello, world!  </p>");
+} catch (Hyperbuild.SyntaxException e) {
+    System.err.println(e.getMessage());
 }
+
+// Alternatively, minify in place:
+assert source instanceof ByteBuffer && source.isDirect();
+Hyperbuild.minifyInPlace(source);
 ```
 
 </details>
@@ -137,7 +182,10 @@ Add the PyPI project as a dependency and install it using `pip` or `pipenv`.
 ```python
 import hyperbuild
 
-minified = hyperbuild.minify("<p>  Hello, world!  </p>")
+try:
+    minified = hyperbuild.minify("<p>  Hello, world!  </p>")
+except SyntaxError as e:
+    print(e)
 ```
 
 </details>
@@ -163,6 +211,10 @@ print Hyperbuild.minify "  Hello, world!  "
 
 ## 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:
@@ -206,7 +258,7 @@ Reduce a sequence of whitespace characters in text nodes to a single space (U+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.
 
-Remove any text nodes that only consist of whitespace characters.
+Remove any text nodes between tags that only consist of whitespace characters.
 
 <table><thead><tr><th>Before<th>After<tbody><tr><td>
 
@@ -381,10 +433,10 @@ Spaces are removed between attributes if possible.
 Entities are decoded if valid (see relevant parsing section) and their decoded characters as UTF-8 is shorter or equal in length.
 
 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`.
 
-Right chevrons after any decoding in text are encoded to `&GT` if possible or `&GT;` otherwise. 
+Left chevrons after any decoding in text are encoded to `&LT` if possible or `&LT;` otherwise.
 
 ### Comments
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hyperbuild
 version: !ruby/object:Gem::Version
-  version: 0.0.39
+  version: 0.1.1
 platform: ruby
 authors:
 - Wilson Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-26 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiddle