Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Conformance suite

aozora ships a WPT-style conformance corpus so other implementations of the Aozora Bunko notation (the tree-sitter reference grammar, third-party ports, alternate parsers in other languages) can measure their adherence against the same set of cases the Rust parser is held to.

Tier model

LevelMeaningEffect on xtask conformance run
mustRequired for any conforming implementation.A failure here exits non-zero.
shouldRecommended but not strictly required.A failure here logs a warning.
mayOptional; implementations decide.Pure information; never fails.

The tier is declared per case in crates/aozora-conformance/fixtures/render/<case>/meta.toml alongside a feature tag (ruby, bouten, composite, recovery, …). The runner aggregates pass / fail counts by (feature, level).

Running

just conformance               # full suite, exits non-zero on must-fail
just render-gate               # the byte-identical render gate, K3-style
xtask conformance run          # invoke the runner directly

A successful run also writes crates/aozora-book/src/conformance-results.json with per-case detail. The JSON shape is stable; downstream dashboards / shields parse it.

What gets compared

The runner pins six axes per fixture:

  1. tree.to_html() byte-identical to expected.html.
  2. tree.serialize() byte-identical to expected.serialize.txt.
  3. aozora::wire::serialize_diagnostics(tree.diagnostics()) byte-identical to expected.diagnostics.json.
  4. aozora::wire::serialize_nodes(&tree) byte-identical to expected.nodes.json.
  5. aozora::wire::serialize_pairs(&tree) byte-identical to expected.pairs.json.
  6. aozora::wire::serialize_container_pairs(&tree) byte-identical to expected.container_pairs.json.

Axes 1–2 anchor the human-readable surface; axes 3–6 pin the JSON projections that drivers (FFI / WASM / PyO3) consume in production, so a regression that survives the renderer gate but breaks a wire client lights up here.

All six goldens regenerate via UPDATE_GOLDEN=1 cargo test -p aozora-conformance --test render_gate after intentional output changes.

Implementations

The runner currently targets a single implementation — the Rust parser itself. The results.json format carries an implementation field so external runs can append their own results without disturbing the canonical Rust pass-rate.

See also