domq 0.5.0

Tiny, zero-dependency, forgiving HTML parser: turn messy real-world HTML into a clean DOM tree (and JSON). WASM-first, no_std-friendly.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

# Measured: conformance and reader mode

domq publishes numbers instead of adjectives. Two reports are generated from
external test suites and checked in CI, so every change to the parser or the
reader-mode heuristic shows its effect in the pull request.

## How close the trees are to a browser's

[docs/conformance.md](https://github.com/iamsaquib8/domq/blob/main/docs/conformance.md)
runs the **1,959 HTML tree-construction tests** (the html5lib tests, now
maintained in web-platform-tests) against domq. Each test is scored twice:

- **exact**: the tree, dumped in the html5lib format, matches line for line.
  This is low by design, since most expected trees start with the `<html>`,
  `<head>` and `<body>` elements browsers insert and domq does not;
- **same structure**: the trees match once those implied wrappers,
  namespaces and whitespace-only text are set aside. A failure here is a real
  difference from a browser.

There are **0 panics** on the whole suite. The report breaks the results down
by area (character references, tables, mis-nested formatting, foreign
content, …) and explains the gaps that are there by design.

## How well reader mode finds the article

[docs/reader-mode.md](https://github.com/iamsaquib8/domq/blob/main/docs/reader-mode.md)
scores `main_content()` against **Mozilla Readability's 130 labelled test
pages**, as word-level precision, recall and F1 against the article Firefox's
reader view extracts, next to the score of the whole page as a baseline. It
also compares `metadata()` field by field, and lists the hardest pages.

## Run them yourself

```sh
sh conformance/fetch.sh     # pinned WPT and Readability commits, sparse fetch
cargo run --release --manifest-path conformance/Cargo.toml
cargo run --release --manifest-path conformance/Cargo.toml -- --failures tables01.dat
cargo run --release --manifest-path conformance/Cargo.toml --bin reader -- --explain engadget
```

## Other checks

Property tests ("never panics" and tree invariants), snapshot tests over a
corpus of messy pages, fuzzing (`parse`, `select`, `markdown`, and a
differential target against html5ever on the subset domq claims to handle like
a browser), `no_std` and MSRV builds, a zero-dependency check, and a size
budget for the wasm module.