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-04-29 10:09:51 -04:00
Currently in beta, working on documentation and tests. Issues and pull requests welcome!
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.
- No dynamic memory is allocated during processing, which increases safety and performance.
- Advanced whitespace handling options allow maximum minification while retaining valid 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
Guide below is currently WIP.
2018-06-30 06:37:24 -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-04-29 10:09:51 -04: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
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-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-26 01:16:13 -05:00
For example, this means that it's not an error to have self-closing tags, having multiple `<body>` elements, using incorrect attribute names and values, or using `<br>` 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-26 01:16:13 -05:00
### Entities
2018-07-04 07:23:17 -04:00
2019-12-26 01:16:13 -05:00
Well-formed entities are decoded, including in attribute values.
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-26 01:16:13 -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-04-29 10:09:51 -04:00
## Development
2018-08-03 08:47:59 -04:00
2019-04-29 10:09:51 -04:00
Currently, hyperbuild has a few limitations:
2018-06-30 06:37:24 -04:00
2019-12-26 01:16:13 -05:00
- Only UTF-8/ASCII is supported.
2019-04-29 10:09:51 -04:00
- Not aware of exotic Unicode whitespace characters.
2018-06-30 06:37:24 -04:00
2019-04-29 10:09:51 -04:00
Patches to change any of these welcome!
