min_html 0.18.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 976a849823090ce6aa8e7d2f448562ab300701fe95bb21f56c770c02a903a0d7
+  data.tar.gz: e1ea6b30ddfc6334be3f11414974a95f97797a099167bf340525574739bfe68e
+SHA512:
+  metadata.gz: f95eea2b2d9ed46611ca75d173e2b54e064f43b68a47919da944af174988ce83772bd21c29a7c7551bf8fd3343ffdc65abcd4f5e59bdd989eeacd28ad4265a09
+  data.tar.gz: 4dcb1b9eceb08c8c33646d406736e694f48ba7ac9a7acdc6faa13a0ac9496a5fe2b5b4dcb7d0e573679417254963fad912abc66aea98ea9f590746bf90aebaab

data/README.md

@@ -0,0 +1,511 @@
+<h1>
+min-html
+<img width="24" src="./icon/cli.png">
+<img width="24" src="./icon/deno.png">
+<img width="24" src="./icon/java.png">
+<img width="24" src="./icon/nodejs.png">
+<img width="24" src="./icon/python.png">
+<img width="24" src="./icon/ruby.png">
+<img width="24" src="./icon/rust.png">
+<img width="24" src="./icon/wasm.png">
+</h1>
+
+A Rust HTML minifier meticulously optimised for speed and effectiveness, with bindings for other languages.
+
+- Advanced minification strategy beats other minifiers in effectiveness while still being much faster.
+- Handles [invalid HTML](./notes/Parsing.md) and [templating syntax](#templating-syntax).
+- Uses [oxc](https://github.com/oxc-project/oxc) and [lightningcss](https://github.com/parcel-bundler/lightningcss) for super fast JS and CSS minification.
+
+View the [changelog](./CHANGELOG.md) to see the latest updates.
+
+## Performance
+
+Comparison with [html-minifier-next](https://github.com/j9t/html-minifier-next) and [minimize](https://github.com/Swaagie/minimize), run on the top web pages. [See the breakdown here.](./bench)
+
+<img width="400" alt="Chart showing speed of HTML minifiers" src="./bench/graphs/average-speeds.png"><img width="400" alt="Chart showing compression of HTML minifiers" src="./bench/graphs/average-sizes.png">
+
+The [onepass](https://github.com/QQSHI13/min-html/tree/master/min-html-onepass) variant is even more optimised for speed. See its [README](https://github.com/QQSHI13/min-html/tree/master/min-html-onepass) for more details.
+
+## Compatibility and usage
+
+<details>
+<summary><img width="24" src="./icon/cli.png"> <strong>CLI</strong></summary>
+
+The CLI is called [minhtml](./minhtml).
+Precompiled binaries are available for Linux (ARM64 and x64), macOS (ARM64 and x64), and Windows (x64).
+You can download them in the GitHub release.
+
+If you have Cargo installed, you can also build and install from source: `cargo install minhtml-cli`.
+
+### Use
+
+Use the `--help` argument for more details.
+
+```bash
+minhtml --output /path/to/output.min.html --keep-closing-tags --minify-css /path/to/src.html
+```
+
+To quickly parallel process a batch of files in place:
+
+```bash
+minhtml --keep-closing-tags --minify-css /path/to/**/*.html
+```
+
+</details>
+
+<details>
+<summary><img width="24" src="./icon/rust.png"> <strong>Rust</strong></summary>
+
+### Get
+
+```toml
+[dependencies]
+min-html = "0.18.1"
+```
+
+### Use
+
+Check out the [docs](https://docs.rs/min-html) for API and usage examples.
+
+</details>
+
+<details>
+<summary><img width="24" src="./icon/deno.png"> <strong>Deno</strong></summary>
+
+- Package: [@minhtml/deno](https://jsr.io/@minhtml/deno/)
+- Binding: [WASM](https://webassembly.org/)
+- Platforms: All
+
+### Get
+
+Add the JSR package:
+
+```
+deno add jsr:@minhtml/deno
+```
+
+### Use
+
+```ts
+import init, {minify} from "@minhtml/deno";
+
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+
+await init();
+
+const minified = decoder.decode(minify(encoder.encode("<p>  Hello, world!  </p>"), { keep_spaces_between_attributes: true, keep_comments: true }));
+```
+
+All [`Cfg` fields](https://docs.rs/min-html/latest/min_html/struct.Cfg.html) are available as snake_case properties on the object provided as the second argument; if any are not set, they default to `false`.
+
+</details>
+
+<details>
+<summary><img width="24" src="./icon/nodejs.png"> <strong>Node.js</strong></summary>
+
+- Package: [@minhtml/node](https://www.npmjs.com/package/@minhtml/node)
+- Binding: [Neon](https://github.com/neon-bindings/neon)
+- Platforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Node.js 10.0.0 and higher
+
+### Get
+
+Using npm:
+
+```bash
+npm i @minhtml/node
+```
+
+Using Yarn:
+
+```bash
+yarn add @minhtml/node
+```
+
+### Use
+
+TypeScript definitions are available.
+
+```ts
+import { Buffer } from "node:buffer";
+import minifyHtml from "@minhtml/node";
+// Or `const minifyHtml = require("@minhtml/node")` if not using TS/ESM.
+
+const minified = minifyHtml.minify(Buffer.from("<p>  Hello, world!  </p>"), { keep_spaces_between_attributes: true, keep_comments: true });
+```
+
+All [`Cfg` fields](https://docs.rs/min-html/latest/min_html/struct.Cfg.html) are available as snake_case properties on the object provided as the second argument; if any are not set, they default to `false`.
+
+</details>
+
+<details>
+<summary><img width="24" src="./icon/java.png"> <strong>Java</strong></summary>
+
+- Package: [com.qqshi13.minhtml](https://search.maven.org/artifact/com.qqshi13.minhtml/min-html)
+- Binding: [JNI](https://github.com/jni-rs/jni-rs)
+- Platforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Java 8 and higher
+
+### Get
+
+Add as a Maven dependency:
+
+```xml
+<dependency>
+  <groupId>com.qqshi13.minhtml</groupId>
+  <artifactId>min-html</artifactId>
+  <version>0.18.2</version>
+</dependency>
+```
+
+### Use
+
+```java
+import com.qqshi13.minhtml.Configuration;
+import com.qqshi13.minhtml.MinifyHtml;
+
+Configuration cfg = new Configuration.Builder()
+    .setKeepHtmlAndHeadOpeningTags(true)
+    .setMinifyCss(true)
+    .build();
+
+String minified = MinifyHtml.minify("<p>  Hello, world!  </p>", cfg);
+```
+
+All [`Cfg` fields](https://docs.rs/min-html/latest/min_html/struct.Cfg.html) are available as camelCase setter methods on the `Builder`; if any are not set, they default to `false`.
+
+</details>
+
+<details>
+<summary><img width="24" src="./icon/python.png"> <strong>Python</strong></summary>
+
+- Package: [min-html](https://pypi.org/project/min-html)
+- Binding: [PyO3](https://github.com/PyO3/pyo3)
+- Platforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Python 3.8 to 3.14
+
+### Get
+
+Add the PyPI project as a dependency and install it using `pip` or `pipenv`.
+
+### Use
+
+```python
+import min_html
+
+minified = min_html.minify("<p>  Hello, world!  </p>", minify_js=True, remove_processing_instructions=True)
+```
+
+All [`Cfg` fields](https://docs.rs/min-html/latest/min_html/struct.Cfg.html) are available as Python keyword arguments; if any are omitted, they default to `False`.
+
+</details>
+
+<details>
+<summary><img width="24" src="./icon/ruby.png"> <strong>Ruby</strong></summary>
+
+- Package: [min_html](https://rubygems.org/gems/min_html)
+- Binding: [rb-sys](https://github.com/oxidize-rb/rb-sys) and [magnus](https://github.com/matsadler/magnus)
+- Platforms: Linux (ARM64 and x64), macOS (ARM64 and x64), Windows (x64); Ruby 3.2 to 3.4
+
+### Get
+
+Add the library as a dependency to `Gemfile` or `*.gemspec`.
+
+### Use
+
+```ruby
+require 'min_html'
+
+print min_html("<p>  Hello, world!  </p>", { :keep_spaces_between_attributes => true, :minify_js => true })
+```
+
+All [`Cfg` fields](https://docs.rs/min-html/latest/min_html/struct.Cfg.html) are available; if any are omitted, they default to `false`.
+
+</details>
+
+<details>
+<summary><img width="24" src="./icon/wasm.png"> <strong>WASM</strong></summary>
+
+- Package: [@minhtml/wasm](https://npmjs.org/package/@minhtml/wasm)
+- Binding: [WASM](https://webassembly.org/)
+- Platforms: All
+
+A bundler may be required to use the WebAssembly module, see [this](https://rustwasm.github.io/wasm-bindgen/reference/deployment.html#bundlers) for more details.
+
+### Use
+
+```ts
+import init, {minify} from "@minhtml/wasm";
+
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+
+await init();
+
+const minified = decoder.decode(minify(encoder.encode("<p>  Hello, world!  </p>"), { keep_spaces_between_attributes: true, keep_comments: true }));
+```
+
+All [`Cfg` fields](https://docs.rs/min-html/latest/min_html/struct.Cfg.html) are available as snake_case properties on the object provided as the second argument; if any are not set, they default to `false`.
+
+</details>
+
+## Templating syntax
+
+min-html can parse and preserve `{{`/`{%`/`{#` and `<%` syntax in the source code, which allows minification of many HTML templates written for most engines like Pebble, Mustache, Django, Go, Jinja, Twix, Nunjucks, Handlebars, Sailfish, JSP, EJS, and ERB. Look for the `preserve_*_template_syntax` Cfg options.
+
+PHP blocks (`<?php` or `<?=`) also happen to be processing instructions, which are preserved by default.
+
+Note that in all of these syntax, the parsing is "dumb": it will simply look for the next subsequence of characters that match the closing delimiter. This may cause issues if nesting or string literals appear inside these blocks, but this should be rare.
+
+## Minification
+
+### Spec compliance
+
+WHATWG is the current HTML standard and [obsoletes all previous standards](https://www.w3.org/html/). WHATWG lists suggested validators [here](https://whatwg.org/validator/).
+
+To minify even further, it's possible to enable options that may output HTML that doesn't fully pass validation, but is still interpreted and rendered correctly according to the [WHATWG parsing specification](https://html.spec.whatwg.org/multipage/parsing.html), which major browser engines (Firefox, Chrome, Safari) implement. Refer to these options:
+
+- `allow_noncompliant_unquoted_attribute_values`
+- `allow_optimal_entities`
+- `allow_removing_spaces_between_attributes`
+- `minify_doctype`
+
+In Rust, `Cfg::enable_possibly_noncompliant` can enable all of these at once.
+
+### Whitespace
+
+min-html 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, min-html chooses which ones to use depending on the containing element.
+
+<details>
+<summary><strong>Collapse whitespace</strong></summary>
+
+> **Applies to:** any element except [whitespace sensitive](./min-html-common/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](./min-html-common/src/spec/tag/whitespace.rs), [content](src/spec/tag/whitespace.rs), [content-first](./min-html-common/src/spec/tag/whitespace.rs), and [formatting](./min-html-common/src/spec/tag/whitespace.rs) elements.
+
+Remove any text nodes between tags 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](./min-html-common/src/spec/tag/whitespace.rs) and [formatting](./min-html-common/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
+
+min-html assumes HTML and SVG elements are used in specific ways, based on standards and best practices. By making these assumptions, it can apply optimal whitespace minification strategies. If these assumptions do not hold, consider adjusting the HTML source or turning off whitespace minification.
+
+|Group|Elements|Expected children|
+|---|---|---|
+|Formatting|`a`, `strong`, [and others](./min-html-common/src/spec/tag/whitespace.rs)|Formatting elements, text.|
+|Content|`h1`, `p`, [and others](./min-html-common/src/spec/tag/whitespace.rs)|Formatting elements, text.|
+|Layout|`div`, `ul`, [and others](./min-html-common/src/spec/tag/whitespace.rs)|Layout elements, content elements.|
+|Content-first|`label`, `li`, [and others](./min-html-common/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 opening and 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), any `>`, and any whitespace encoded.
+
+Attributes have their whitespace (after any decoding) trimmed and collapsed when possible.
+
+Boolean attribute values are removed.
+Some other attributes 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 when possible.
+
+### Entities
+
+Entities are decoded if they're valid and shorter or equal in length when decoded. UTF-8 sequences that have a shorter entity representation are encoded.
+
+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).
+
+Encoding is avoided when possible; for example, `<` are only encoded in content if they are followed by a valid tag name character.
+If necessary, the shortest entity representation is chosen.
+
+### 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
+
+min-html can process any HTML, handling all possible syntax (including invalid ones) gracefully like browsers. See [Parsing.md](./notes/Parsing.md) for more details.
+
+## Issues and contributions
+
+Pull requests and any contributions welcome!
+
+If min-html did something unexpected, misunderstood some syntax, or incorrectly kept/removed some code, [raise an issue](https://github.com/QQSHI13/min-html/issues) with some relevant code that can be used to reproduce and investigate the issue.

data/ext/min_html/extconf.rb

@@ -0,0 +1,4 @@
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("min_html/min_html")

data/lib/min_html.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  /(?<ruby_version>\d+\.\d+)/ =~ RUBY_VERSION
+  require_relative "#{ruby_version}/min_html"
+rescue LoadError
+  require_relative "min_html.so"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: min_html
+version: !ruby/object:Gem::Version
+  version: 0.18.2
+platform: ruby
+authors:
+- QQSHI13
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.39
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.39
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+executables: []
+extensions:
+- ext/min_html/extconf.rb
+extra_rdoc_files: []
+files:
+- README.md
+- ext/min_html/extconf.rb
+- lib/min_html.rb
+homepage: https://github.com/QQSHI13/min-html
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Extremely fast and smart HTML + JS + CSS minifier
+test_files: []