Get

[dependencies]
hyperbuild = { version = "0.2.4", features = ["js-esbuild"] }

Building with the js-esbuild feature requires the Go compiler to be installed as well, to build the JS minifier.

If the js-esbuild feature is not enabled, cfg.minify_js will have no effect.

Use

use hyperbuild::{Cfg, FriendlyError, hyperbuild, hyperbuild_copy, hyperbuild_friendly_error, hyperbuild_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 hyperbuild(&mut code, cfg) {
        Ok(minified_len) => {}
        Err((error_type, error_position)) => {}
    };

    // Creates a vector copy containing only minified code
    // instead of minifying in-place.
    match hyperbuild_copy(&code, cfg) {
        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, cfg) {
        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, cfg) {
        Ok(minified_len) => {}
        Err(FriendlyError { position, message, code_context }) => {
            eprintln!("Failed at character {}:", position);
            eprintln!("{}", message);
            eprintln!("{}", code_context);
        }
    };
}

hyperbuild is on npm, available as a Node.js native module, and supports Node.js versions 8 and higher.

Get

Using npm:

npm i hyperbuild

Using Yarn:

yarn add hyperbuild

Use

const hyperbuild = require("hyperbuild");

const cfg = { minifyJs: false };
const minified = hyperbuild.minify("<p>  Hello, world!  </p>", cfg);

// Alternatively, minify in place to avoid copying.
const source = Buffer.from("<p>  Hello, world!  </p>", cfg);
hyperbuild.minifyInPlace(source);

hyperbuild is also available for TypeScript:

import * as hyperbuild from "hyperbuild";
import * as fs from "fs";

const cfg = { minifyJs: false };
const minified = hyperbuild.minify("<p>  Hello, world!  </p>", cfg);
hyperbuild.minifyInPlace(fs.readFileSync("source.html"), cfg);

hyperbuild is available via JNI, and supports Java versions 7 and higher.

Get

Add as a Maven dependency:

<dependency>
  <groupId>in.wilsonl.hyperbuild</groupId>
  <artifactId>hyperbuild</artifactId>
  <version>0.2.4</version>
</dependency>

Use

import in.wilsonl.hyperbuild.Hyperbuild;

Hyperbuild.Configuration cfg = new Hyperbuild.Configuration.Builder()
    .setMinifyJs(false)
    .build();
try {
    String minified = Hyperbuild.minify("<p>  Hello, world!  </p>", cfg);
} catch (Hyperbuild.SyntaxException e) {
    System.err.println(e.getMessage());
}

// Alternatively, minify in place:
assert source instanceof ByteBuffer && source.isDirect();
Hyperbuild.minifyInPlace(source, cfg);

hyperbuild is on PyPI, available as a native module, and supports CPython (the default Python interpreter) versions 3.5 and higher.

Get

Add the PyPI project as a dependency and install it using pip or pipenv.

Use

import hyperbuild

try:
    minified = hyperbuild.minify("<p>  Hello, world!  </p>", minify_js=False)
except SyntaxError as e:
    print(e)

hyperbuild is published on RubyGems, available as a native module for macOS and Linux, and supports Ruby versions 2.5 and higher.

Get

Add the library as a dependency to Gemfile or *.gemspec.

Use

require 'hyperbuild'

print Hyperbuild.minify("<p>  Hello, world!  </p>", { :minify_js => false })

Applies to: any element except whitespace sensitive elements.

Reduce a sequence of whitespace characters in text nodes to a single space (U+0020).

<p>↵
··The·quick·brown·fox↵
··jumps·over·the·lazy↵
··dog.↵
</p>

<p>·The·quick·brown·fox·jumps·over·the·lazy·dog.·</p>

Applies to: any element except whitespace sensitive, content, content-first, and formatting elements.

Remove any text nodes between tags that only consist of whitespace characters.

<ul>↵
··<li>A</li>↵
··<li>B</li>↵
··<li>C</li>↵
</ul>

<ul>↵
··<li>A</li><li>B</li><li>C</li>↵
</ul>

Applies to: any element except whitespace sensitive and formatting elements.

Remove any leading/trailing whitespace from any leading/trailing text nodes of a tag.

<p>↵
··Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup>↵
</p>

<p>Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup></p>

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.

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

<p>↵
··Hey,·I·<em>just</em>·found↵
··out·about·this·<strong>cool</strong>·website!↵
··<sup>[1]</sup>↵
</p>

After

<p>Hey,·I·<em>just</em>·found·out·about·this·<strong>cool</strong>·website!·<sup>[1]</sup></p>

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

<ul>↵
··<li>A</li>↵
··<li>B</li>↵
··<li>C</li>↵
</ul>

After

<ul><li>A</li><li>B</li><li>C</li></ul>

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

<li>↵
··<article>↵
····<section></section>↵
····<section></section>↵
··</article>↵
</li>

After

<li><article><section></section><section></section></article></li>