hyperbuild 0.0.41 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9141e093255957cfcf9860b3ae0d00117da370b124d35ed941dbd8c045edcab5
-  data.tar.gz: 0b43e3419d2ccd163f6dadf931427e67ea9489303df4534faff910faa297b10c
+  metadata.gz: 4e6a1e10782a31b58f66b59d7cd44ef2dbd5d8dc2261381b13b2d254f8b5c4a2
+  data.tar.gz: ee8f6ee1d6915cd7f5f1d0639cb721a537c7b1f8049630c997c52540275ff057
 SHA512:
-  metadata.gz: e4ba28a7036211abc22a7a00c8b9f786335dc495e9dbf818065fc6dff958a472a3cb040f2250e138407fbb6441462ec3abddd94b0c530cf3988dd443aabdb37e
-  data.tar.gz: bb44f45b2b1ae48a482ede0962f2b11605f41e35c5446f2fc6fa499dd7f1118c547e13e2388fd928e257844a5b29a853af3493d5e102784915c777e86bc02b54
+  metadata.gz: b7f0adf1f11aab729d17a00c04f6b01c5d1fdc8da6c0d8b3013218382bd0925091ce8293ac72a9aad730bec937cdc3db4b9e74c6d2c58989ad97a849cfdb9c33
+  data.tar.gz: eac51647abc8c8646d1b818303d3a8fb5af3c5ff046db8a0bafa385271cbef7dc68415453881bfac5b0e7e31497d3f4285666cfe996a20f5c4fa2e01961f258c

data/README.md

@@ -15,21 +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.41/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.0.41/average-sizes.png">
+<img width="435" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.1.3/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/hyperbuild/bench/0.1.3/average-sizes.png">
 
 ## Usage
 
 ### CLI
 
-Precompiled binaries are available for x86-64 Windows, macOS, and Linux. To compile and install from source, run `cargo install hyperbuild`, which requires [Rust](https://www.rust-lang.org/tools/install).
+Precompiled binaries are available for x86-64 Windows, macOS, and Linux.
 
 ##### Get
 
-[Windows](https://wilsonl.in/hyperbuild/bin/0.0.41-windows-x86_64.exe) |
-[macOS](https://wilsonl.in/hyperbuild/bin/0.0.41-macos-x86_64) |
-[Linux](https://wilsonl.in/hyperbuild/bin/0.0.41-linux-x86_64)
+[Windows](https://wilsonl.in/hyperbuild/bin/0.1.3-windows-x86_64.exe) |
+[macOS](https://wilsonl.in/hyperbuild/bin/0.1.3-macos-x86_64) |
+[Linux](https://wilsonl.in/hyperbuild/bin/0.1.3-linux-x86_64)
 
 ##### Use
 
@@ -46,19 +46,48 @@ hyperbuild --src /path/to/src.html --out /path/to/output.min.html
 
 ```toml
 [dependencies]
-hyperbuild = "0.0.41"
+hyperbuild = "0.1.3"
 ```
 
 ##### Use
 
 ```rust
-use hyperbuild::hyperbuild;
+use hyperbuild::{FriendlyError, hyperbuild};
 
 fn main() {
     let mut code = b"<p>  Hello, world!  </p>".to_vec();
+
+    // 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)) => {}
+    };
+
+    // Creates a vector copy containing only minified code
+    // instead of minifying in-place.
+    match hyperbuild_copy(&code) {
+        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) {
+        Ok(()) => {}
+        Err((error_type, error_position)) => {}
+    };
+
+    // 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) {
+        Ok(minified_len) => {}
+        Err(FriendlyError { position, message, code_context }) => {
+            eprintln!("Failed at character {}:", position);
+            eprintln!("{}", message);
+            eprintln!("{}", code_context);
+        }
     };
 }
 ```
@@ -90,6 +119,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>
@@ -107,7 +150,7 @@ Add as a Maven dependency:
 <dependency>
   <groupId>in.wilsonl.hyperbuild</groupId>
   <artifactId>hyperbuild</artifactId>
-  <version>0.0.41</version>
+  <version>0.1.3</version>
 </dependency>
 ```
 
@@ -116,11 +159,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>
@@ -139,7 +186,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>
@@ -165,6 +215,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:
@@ -208,7 +262,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>
 
@@ -383,10 +437,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.41
+  version: 0.1.3
 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