hyperbuild 0.0.27 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ecb04d69e6820cb386fea2c8a3bf2bd282418b26c7e1044429118797956ce5
-  data.tar.gz: fd2c1cba2d79d3efdf0ff6e4dea0d0d6491b3fe240f2a4604632ebac6271290a
+  metadata.gz: 97f5a53d0edfa1c0d48de35b710be8a28720d531d5d103ac444c61a966d54945
+  data.tar.gz: 34843de3acf3029b8ca4627b88a3cfcc7c16bc5db8505f909c8f22c9b24a1a4a
 SHA512:
-  metadata.gz: 193453d84c4e68f7b1c9ee24bccf159918b6c97add863a0a296c10531c57419c61755e94284a0cca2c1c8bffae12eb3575f2fbeeb7ddc3b95109d44d61543200
-  data.tar.gz: 45f6654248824035e3ee196240bb273d8252c95fe046a1b1c0bb2c754e9ad1c189c148f63a07bc5c69f5d0fc8199bec2a78bc705e8ffe3ac9bf5e462470af1ef
+  metadata.gz: d6f894c0c4db260af124633733eabf6462f7034ee2306148dba7037b7d6b8a90454e1fb4777e0b98333207490ff060c756fe7c390fdf0f289b028ced43975ce5
+  data.tar.gz: 6ec47700614cb897f1bab5bf23d5f7fa86cc4f4b56bd41d7e4d45fdd8adcf4542c1bd4a72d0ec8d7d56ce0253485dead9d60c617b19aacb62d93ce8138f9cfae

data/README.md

@@ -0,0 +1,438 @@
+# hyperbuild
+
+A fast one-pass in-place HTML minifier written in Rust with context-aware whitespace handling.
+
+Available as:
+- CLI for Windows, 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.
+
+## 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.
+
+<img width="435" alt="Chart showing speed of HTML minifiers" src="./bench/results/average-speeds.png"> <img width="435" alt="Chart showing effectiveness of HTML minifiers" src="./bench/results/average-sizes.png">
+
+## Usage
+
+### CLI
+
+##### Get
+
+[Windows](https://wilsonl.in/hyperbuild/bin/0.0.28-windows-x86_64.exe) |
+[macOS](https://wilsonl.in/hyperbuild/bin/0.0.28-macos-x86_64) |
+[Linux](https://wilsonl.in/hyperbuild/bin/0.0.28-linux-x86_64)
+
+##### Use
+
+```bash
+hyperbuild --src /path/to/src.html --out /path/to/output.min.html
+```
+
+### API
+
+<details>
+<summary><strong>Rust</strong></summary>
+
+##### Get
+
+```toml
+[dependencies]
+hyperbuild = "0.0.28"
+```
+
+##### Use
+
+```rust
+use hyperbuild::hyperbuild;
+
+fn main() {
+    let mut code = b"<p>  Hello, world!  </p>".to_vec();
+    match hyperbuild(&mut code) {
+        Ok(minified_len) => {}
+        Err((error_type, error_at_char_no)) => {}
+    };
+}
+```
+
+</details>
+
+<details>
+<summary><strong>Node.js</strong></summary>
+
+hyperbuild is [on npm](https://www.npmjs.com/package/hyperbuild), available as a [Node.js native module](https://neon-bindings.com/), and supports Node.js versions 8 and higher.
+
+##### Get
+
+Using npm:
+
+```bash
+npm i hyperbuild
+```
+
+Using Yarn:
+
+```bash
+yarn add hyperbuild
+```
+
+##### Use
+
+```js
+const hyperbuild = require("hyperbuild");
+
+const minified = hyperbuild.minify("<p>  Hello, world!  </p>");
+```
+
+</details>
+
+<details>
+<summary><strong>Java</strong></summary>
+
+hyperbuild is available via [JNI](https://github.com/jni-rs/jni-rs), and supports Java versions 7 and higher.
+
+##### Get
+
+Download the [JAR](https://wilsonl.in/hyperbuild/bin/0.0.28.jar) file.
+
+##### Use
+
+Make sure to add the JAR file to the class path.
+
+```java
+import in.wilsonl.hyperbuild.Hyperbuild;
+
+class Main {
+    public static void main(String[] args) {
+        String minified = Hyperbuild.minify("<p>  Hello, world!  </p>");
+    }
+}
+```
+
+</details>
+
+<details>
+<summary><strong>Python</strong></summary>
+
+hyperbuild is available as a [native module](https://github.com/PyO3/pyo3), and supports CPython (the default Python interpreter) versions 3.5 and higher.
+
+##### Get
+
+Download the native module for [Windows](https://wilsonl.in/hyperbuild/bin/0.0.28-windows-x86_64-python.pyd), [macOS](https://wilsonl.in/hyperbuild/bin/0.0.28-macos-x86_64-python.so), or [Linux](https://wilsonl.in/hyperbuild/bin/0.0.28-linux-x86_64-python.so).
+
+Rename the file to `hyperbuild.pyd` on Windows or `hyperbuild.so` on macOS/Linux.
+
+##### Use
+
+Make sure the native module can be [found by Python](https://docs.python.org/3/tutorial/modules.html#the-module-search-path). This is usually done by placing it into a folder declared in the `PYTHONPATH` environment variable or `sys.path` value, or the same folder as the script that will import it.
+
+```python
+import hyperbuild
+
+minified = hyperbuild.minify("<p>  Hello, world!  </p>")
+```
+
+</details>
+
+<details>
+<summary><strong>Ruby</strong></summary>
+
+hyperbuild is available as a [native module](https://github.com/danielpclark/rutie) for macOS and Linux, and supports Ruby versions 2.5 and higher.
+
+##### Get
+
+Download and install the [gem](https://wilsonl.in/hyperbuild/bin/0.0.28.gem).
+
+##### Use
+
+```ruby
+require 'hyperbuild'
+
+print hyperbuild.minify "<p>  Hello, world!  </p>"
+```
+
+</details>
+
+## Minification
+
+### Whitespace
+
+hyperbuild has advanced context-aware whitespace minification that does things such as:
+
+- Leave whitespace untouched in `pre` and `code`, which are whitespace sensitive.
+- Trim and collapse whitespace in content tags, as whitespace is collapsed anyway when rendered.
+- Remove whitespace in layout tags, which allows the use of inline layouts while keeping formatted code.
+
+#### Methods
+
+There are three whitespace minification methods. When processing text content, hyperbuild chooses which ones to use depending on the containing element.
+
+<details>
+<summary><strong>Collapse whitespace</strong></summary>
+
+> **Applies to:** any element except [whitespace sensitive](./src/spec/tag/whitespace.rs) elements.
+
+Reduce a sequence of whitespace characters in text nodes to a single space (U+0020).
+
+<table><thead><tr><th>Before<th>After<tbody><tr><td>
+
+```html
+<p>↵
+··The·quick·brown·fox↵
+··jumps·over·the·lazy↵
+··dog.↵
+</p>
+```
+
+<td>
+
+```html
+<p>·The·quick·brown·fox·jumps·over·the·lazy·dog.·</p>
+```
+
+</table>
+</details>
+
+<details>
+<summary><strong>Destroy whole whitespace</strong></summary>
+
+> **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.
+
+<table><thead><tr><th>Before<th>After<tbody><tr><td>
+
+```html
+<ul>↵
+··<li>A</li>↵
+··<li>B</li>↵
+··<li>C</li>↵
+</ul>
+```
+
+<td>
+
+```html
+<ul>↵
+··<li>A</li><li>B</li><li>C</li>↵
+</ul>
+```
+
+</table>
+</details>
+
+<details>
+<summary><strong>Trim whitespace</strong></summary>
+
+> **Applies to:** any element except [whitespace sensitive](./src/spec/tag/whitespace.rs) and [formatting](./src/spec/tag/whitespace.rs) elements.
+
+Remove any leading/trailing whitespace from any leading/trailing text nodes of a tag.
+
+<table><thead><tr><th>Before<th>After<tbody><tr><td>
+
+```html
+<p>↵
+··Hey,·I·<em>just</em>·found↵
+··out·about·this·<strong>cool</strong>·website!↵
+··<sup>[1]</sup>↵
+</p>
+```
+
+<td>
+
+```html
+<p>Hey,·I·<em>just</em>·found↵
+··out·about·this·<strong>cool</strong>·website!↵
+··<sup>[1]</sup></p>
+```
+
+</table>
+</details>
+
+#### Element types
+
+hyperbuild recognises elements based on one of a few ways it assumes they are used. By making these assumptions, it can apply optimal whitespace minification strategies.
+
+|Group|Elements|Expected children|
+|---|---|---|
+|Formatting|`a`, `strong`, [and others](./src/spec/tag/whitespace.rs)|Formatting elements, text.|
+|Content|`h1`, `p`, [and others](src/spec/tag/whitespace.rs)|Formatting elements, text.|
+|Layout|`div`, `ul`, [and others](./src/spec/tag/whitespace.rs)|Layout elements, content elements.|
+|Content-first|`label`, `li`, [and others](./src/spec/tag/whitespace.rs)|Like content but could be layout with only one child.|
+
+<details>
+<summary><strong>Formatting elements</strong></summary>
+
+> Whitespace is collapsed.
+
+Formatting elements are usually inline elements that wrap around part of some text in a content element, so its whitespace isn't trimmed as they're probably part of the content.
+
+</details>
+
+<details>
+<summary><strong>Content elements</strong></summary>
+
+> Whitespace is trimmed and collapsed.
+
+Content elements usually represent a contiguous and complete unit of content such as a paragraph. As such, whitespace is significant but sequences of them are most likely due to formatting.
+
+###### Before
+
+```html
+<p>↵
+··Hey,·I·<em>just</em>·found↵
+··out·about·this·<strong>cool</strong>·website!↵
+··<sup>[1]</sup>↵
+</p>
+```
+
+###### After
+
+```html
+<p>Hey,·I·<em>just</em>·found·out·about·this·<strong>cool</strong>·website!·<sup>[1]</sup></p>
+```
+
+</details>
+
+<details>
+<summary><strong>Layout elements</strong></summary>
+
+> Whitespace is trimmed and collapsed. Whole whitespace is removed.
+
+These elements should only contain other elements and no text. This makes it possible to remove whole whitespace, which is useful when using `display: inline-block` so that whitespace between elements (e.g. indentation) does not alter layout and styling.
+
+###### Before
+
+```html
+<ul>↵
+··<li>A</li>↵
+··<li>B</li>↵
+··<li>C</li>↵
+</ul>
+```
+
+###### After
+
+```html
+<ul><li>A</li><li>B</li><li>C</li></ul>
+```
+
+</details>
+
+<details>
+<summary><strong>Content-first elements</strong></summary>
+
+> Whitespace is trimmed and collapsed.
+
+These elements are usually like content elements but are occasionally used like a layout element with one child. Whole whitespace is not removed as it might contain content, but this is OK for using as layout as there is only one child and whitespace is trimmed.
+
+###### Before
+
+```html
+<li>↵
+··<article>↵
+····<section></section>↵
+····<section></section>↵
+··</article>↵
+</li>
+```
+
+###### After
+
+```html
+<li><article><section></section><section></section></article></li>
+```
+
+</details>
+
+### Tags
+
+[Optional closing tags](https://html.spec.whatwg.org/multipage/syntax.html#syntax-tag-omission) are removed.
+
+### Attributes
+
+Any entities in attribute values are decoded, and then the shortest representation of the value is calculated and used:
+
+- Double quoted, with any `"` encoded.
+- Single quoted, with any `'` encoded.
+- Unquoted, with `"`/`'` first character (if applicable), `>` last character (if applicable), and any whitespace encoded.
+
+`class` attributes have their whitespace (after any decoding) trimmed and collapsed.
+
+[Boolean attribute](./gen/attrs.json) values are removed.
+[Some attributes](./gen/attrs.json) are completely removed if their value is empty or the default value after any processing.
+
+`type` attributes on `script` tags with a value equaling a [JavaScript MIME type](https://mimesniff.spec.whatwg.org/#javascript-mime-type) are removed.
+
+If an attribute value is empty after any processing, everything but the name is completely removed (i.e. no `=`), as an empty attribute is implicitly [the same](https://html.spec.whatwg.org/multipage/syntax.html#attributes-2) as an attribute with an empty string value.
+
+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.
+
+Numeric entities that do not refer to a valid Unicode Scalar Value are decoded to U+FFFD 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`.
+
+### Comments
+
+Comments are removed.
+
+### Ignored
+
+Bangs, [processing instructions](https://en.wikipedia.org/wiki/Processing_Instruction), and empty elements are not removed as it is assumed there is a special reason for their declaration.
+
+## Parsing
+
+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.
+
+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>`
+
+However, there are some syntax requirements for speed and sanity reasons.
+
+### Tags
+
+Tag names are case sensitive. For example, this means that `P` won't be recognised as a content element, `bR` won't be considered as a void tag, and the contents of `Script` won't be parsed as JavaScript.
+
+Tags must not be [omitted](https://html.spec.whatwg.org/multipage/syntax.html#syntax-tag-omission). Void tags must not have a separate closing tag e.g. `</input>`.
+
+### Entities
+
+Well-formed entities are decoded, including in attribute values.
+
+They are interpreted as characters representing their decoded value. This means that `&#9;` is considered a whitespace character and could be minified.
+
+Malformed entities are interpreted literally as a sequence of characters.
+
+If a named entity is an invalid reference as per the [specification](https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references), it is considered malformed.
+
+Numeric character references that do not reference a valid [Unicode Scalar Value](https://www.unicode.org/glossary/#unicode_scalar_value) are considered malformed.
+
+### Attributes
+
+Backticks (`` ` ``) are not valid quote marks and not interpreted as such.
+However, backticks are valid attribute value quotes in Internet Explorer.
+
+Special handling of some attributes require case sensitive names and values. For example, `CLASS` won't be recognised as an attribute to minify, and `type="Text/JavaScript"` on a `<script>` will cause the element to be parsed as a [data block](https://html.spec.whatwg.org/dev/scripting.html#data-block) instead of JavaScript code.
+
+### Script and style
+
+`script` and `style` tags must be closed with `</script>` and `</style>` respectively (case sensitive).
+
+hyperbuild does **not** handle [escaped and double-escaped](./notes/Script%20data.md) script content.
+
+## Issues and contributions
+
+Contributions welcome!
+
+If hyperbuild did something unexpected, such as misunderstood some syntax, or incorrectly did/didn't do some minification, [raise an issue](https://github.com/wilsonzlin/hyperbuild/issues) with some relevant code that causes the issue.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyperbuild
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.28
 platform: ruby
 authors:
 - Wilson Lin
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/hyperbuild.rb
 - lib/linux
 - lib/macos