minify_html 0.3.4 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a44a2ef6e047dd840c347c217df9cd5de9da6328bf89a8106d4b48ca4a386903
-  data.tar.gz: a8851749a6dc8c01123bfdc4a4d1d0ce5bbf8d78bbd84775e94f7de8cadfcaa5
+  metadata.gz: 4bd2c89ec4f024b67cea95c499fcf8f0cac743c0b186920ea9ed0400b36d5355
+  data.tar.gz: 2fd88803a4097495d32c026999810e36178fbb43c39af5cdf733d3e58575ba5b
 SHA512:
-  metadata.gz: 5463c9b94824ef30eb6a900f68620814d86aef0250651778ef9e7837f09f2d3a1379daf8e17d905e76035fb6faf453e1d2944e5fcbdf6b9437c8565408dd32fb
-  data.tar.gz: 9d11db9dce3787239a1b2d0ef7886440c452fcc3f5f6ecad37121995493ce0d3ea669b6a96151afa45fcc8acb6dc8d4eedf5d7cfdfc6771f520665d0be447bb5
+  metadata.gz: ba97f98317f76967eb99d4ef6d4db68eeb900e2924fef550c01cee0744a60540a8b79ecf765075cf016dc16f0cfcd10ea1f4e106c5d4a5de443fb7432b8d59f9
+  data.tar.gz: 962ea48bfd7ecdc39b42a60067c415fbadb8d2d3e7160239152052b0c250a79694afc82ccc499dba084c3cf9d497ef974b43608e2663e9f4d078b81bfb126e6a

data/README.md

@@ -1,6 +1,7 @@
 # minify-html
 
-An HTML minifier meticulously optimised for both speed and effectiveness, available for Rust, Node.js, Python, Java, and Ruby.
+An HTML minifier meticulously optimised for both speed and effectiveness written in Rust.
+Comes with native bindings to Node.js, Python, Java, and Ruby.
 
 - Advanced minification strategy beats other minifiers with only one pass.
 - Uses zero memory allocations, SIMD searching, direct tries, and lookup tables.
@@ -11,7 +12,7 @@ An HTML minifier meticulously optimised for both speed and effectiveness, availa
 
 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="415" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.3.4/js/average-speeds.png"> <img width="415" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.3.4/js/average-sizes.png">
+<img width="415" alt="Chart showing speed of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.3.9/js/average-speeds.png"> <img width="415" alt="Chart showing effectiveness of HTML minifiers" src="https://wilsonl.in/minify-html/bench/0.3.9/js/average-sizes.png">
 
 ## Usage
 
@@ -21,9 +22,9 @@ Precompiled binaries are available for x86-64 Linux, macOS, and Windows.
 
 ##### Get
 
-[Linux](https://wilsonl.in/minify-html/bin/0.3.4-linux-x86_64) |
-[macOS](https://wilsonl.in/minify-html/bin/0.3.4-macos-x86_64) |
-[Windows](https://wilsonl.in/minify-html/bin/0.3.4-windows-x86_64.exe)
+[Linux](https://wilsonl.in/minify-html/bin/0.3.9-linux-x86_64) |
+[macOS](https://wilsonl.in/minify-html/bin/0.3.9-macos-x86_64) |
+[Windows](https://wilsonl.in/minify-html/bin/0.3.9-windows-x86_64.exe)
 
 ##### Use
 
@@ -42,58 +43,16 @@ minify-html --src /path/to/src.html --out /path/to/output.min.html
 
 ```toml
 [dependencies]
-minify-html = { version = "0.3.4", features = ["js-esbuild"] }
+minify-html = { version = "0.3.9", 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).
+Building with the `js-esbuild` feature requires the Go compiler to be installed as well, to build the [JS minifier](https://github.com/wilsonzlin/esbuild-rs).
 
 If the `js-esbuild` feature is not enabled, `cfg.minify_js` will have no effect.
 
 ##### Use
 
-```rust
-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();
-    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 in_place(&mut code, cfg) {
-        Ok(minified_len) => {}
-        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 { 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 { error_type, position }) => {}
-    };
-
-    // Identical to `in_place` 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 with_friendly_error(&mut code, cfg) {
-        Ok(minified_len) => {}
-        Err(FriendlyError { position, message, code_context }) => {
-            eprintln!("Failed at character {}:", position);
-            eprintln!("{}", message);
-            eprintln!("{}", code_context);
-        }
-    };
-}
-```
+Check out the [docs](https://docs.rs/minify-html) for API and usage examples.
 
 </details>
 
@@ -161,21 +120,24 @@ Add as a Maven dependency:
 <dependency>
   <groupId>in.wilsonl.minifyhtml</groupId>
   <artifactId>minify-html</artifactId>
-  <version>0.3.4</version>
+  <version>0.3.9</version>
 </dependency>
 ```
 
 ##### Use
 
 ```java
+import in.wilsonl.minifyhtml.Configuration;
 import in.wilsonl.minifyhtml.MinifyHtml;
+import in.wilsonl.minifyhtml.SyntaxException;
 
-MinifyHtml.Configuration cfg = new MinifyHtml.Configuration.Builder()
+Configuration cfg = new Configuration.Builder()
     .setMinifyJs(false)
     .build();
+
 try {
     String minified = MinifyHtml.minify("<p>  Hello, world!  </p>", cfg);
-} catch (MinifyHtml.SyntaxException e) {
+} catch (SyntaxException e) {
     System.err.println(e.getMessage());
 }
 
@@ -448,16 +410,13 @@ 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.
+Entities are decoded if they're valid and shorter or equal in length when decoded.
 
 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`.
 
-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.
+Note that it's possible to get an unintentional entity after removing comments, e.g. `&am<!-- -->p`; minify-html will **not** encode the leading ampersand.
 
 ### Comments
 
@@ -469,44 +428,9 @@ Bangs, [processing instructions](https://en.wikipedia.org/wiki/Processing_Instru
 
 ## Parsing
 
-Only UTF-8/ASCII-encoded HTML code is supported.
-
-minify-html 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.
-
-### 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 not be removed.
-
-### Script and style
-
-`script` and `style` tags must be closed with `</script>` and `</style>` respectively (case sensitive).
-
-minify-html does **not** handle [escaped and double-escaped](./notes/Script%20data.md) script content.
+- Input must be UTF-8.
+- Opening tags must not be [omitted](https://html.spec.whatwg.org/multipage/syntax.html#syntax-tag-omission).
+- [Escaped and double-escaped](./notes/Script%20data.md) script content are not supported.
 
 ## Issues and contributions
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minify_html
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.9
 platform: ruby
 authors:
 - Wilson Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fiddle