2018-06-30 06:37:24 -04:00
# hyperbuild
2019-12-23 06:48:41 -05:00
A fast one-pass in-place HTML minifier written in Rust with advanced whitespace handling.
2018-10-25 07:54:54 -04:00
2019-12-27 06:14:03 -05:00
Currently in beta, working on documentation and tests. Issues and pull requests welcome! Guide below is currently WIP.
2018-06-30 06:37:24 -04:00
## Features
2019-04-29 10:09:51 -04:00
- Minification is done in one pass with no backtracking or DOM/AST building.
2019-12-27 06:32:04 -05:00
- No extra heap memory is allocated during processing, which increases performance.
- Context-aware whitespace handling allows maximum minification while retaining wanted spaces.
2018-06-30 06:37:24 -04:00
2019-04-29 10:09:51 -04:00
## Usage
2018-06-30 06:37:24 -04:00
2019-12-26 01:16:13 -05:00
```bash
hyperbuild --src /path/to/src.html --out /path/to/output.min.html
```
2018-08-07 22:31:28 -04:00
2019-04-29 10:09:51 -04:00
## Minification
2018-07-02 05:21:00 -04:00
2019-04-29 10:09:51 -04:00
### Whitespace
2018-06-30 06:37:24 -04:00
2019-04-29 10:09:51 -04:00
hyperbuild has advanced whitespace minification that can allow strategies such as:
2018-07-04 07:23:17 -04:00
2019-12-27 06:14:03 -05:00
- 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.
### Attributes
Any entities in attribute values are decoded, and then the most optimal representation is calculated and used:
- Double quoted, with any `"` encoded.
- Single quoted, with any `'` encoded.
- Unquoted, with `"` /`'` first char (if applicable) and `>` last char (if applicable), and any whitespace, encoded.
Some attributes have their whitespace (after decoding) trimmed and collapsed, such as `class` .
If the attribute value is empty after any processing, it is completely removed (i.e. no `=` ).
Spaces are removed between attributes if possible.
### Other
- Comments are removed.
- Entities are decoded if valid (see relevant parsing section).
### WIP
- Removal of [optional tags ](https://html.spec.whatwg.org/multipage/syntax.html#syntax-tag-omission ).
- Removal of boolean attribute values.
- Removal of redundant attributes (empty or default value).
- Handling of conditional or special comments.
### Explicitly important
Empty elements and bangs are not removed as it is assumed there is a special reason for their declaration.
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
## Parsing
2018-07-04 07:23:17 -04:00
2019-12-27 06:49:10 -05:00
Only UTF-8/ASCII is supported.
2019-12-26 01:16:13 -05:00
hyperbuild is an HTML minifier and simply does HTML minification. In addition to keeping to one role, hyperbuild almost does no syntax checking or standards enforcement for performance and code complexity reasons.
2018-08-03 08:47:59 -04:00
2019-12-27 06:14:03 -05:00
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>`
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
However, there are some syntax requirements for speed and sanity reasons.
2018-08-03 08:47:59 -04:00
2019-12-26 01:16:13 -05:00
### Tags
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
Tag names are case sensitive.
2018-08-03 08:47:59 -04:00
2019-12-27 06:49:10 -05:00
### Entities
Well-formed entities are decoded, including in attribute values.
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
They are considered as a single character representing their decoded value. This means that `	` is considered a whitespace character and could be minified.
2018-08-03 08:47:59 -04:00
2019-12-26 01:16:13 -05:00
If a named entity is an invalid reference as per the [spec ](https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references ), it is considered malformed and will be interpreted literally.
2019-04-29 10:09:51 -04:00
2019-12-26 08:23:33 -05:00
Numeric character references that do not reference a valid [Unicode Scalar Value ](https://www.unicode.org/glossary/#unicode_scalar_value ) are considered malformed.
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
### Attributes
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
Backticks (`` ` ` `) are not valid quote marks and are not interpreted as such.
However, backticks are valid attribute value quotes in Internet Explorer.
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
It's an error to place whitespace between `=` and attribute names/values.
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
Special handling of some attributes require case-sensitive names and values. For example, `class` and `type="text/javascript"` .
It's an error if there is no whitespace before an attribute.
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
Most likely, the cause of this error is either invalid syntax or something like:
2018-07-04 07:23:17 -04:00
```html
2019-12-26 01:16:13 -05:00
< div class = "a" name = "1" > < / div >
2018-07-04 07:23:17 -04:00
```
2019-12-26 01:16:13 -05:00
(Note the lack of space between the end of the `class` attribute and the beginning of the `name` attribute.)
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
### Script and style
2018-07-04 07:23:17 -04:00
2019-12-27 06:14:03 -05:00
`script` and `style` tags must be closed with `</script>` and `</style>` respectively (case sensitive).
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
Note that the closing tag must not contain any whitespace (e.g. `</script >` ).
2018-07-04 07:23:17 -04:00
2019-12-27 06:18:56 -05:00
[hyperbuild can handle text script content. ](./notes/Text%20script%20content.md )
