mirror of
https://github.com/larvit/adf-codec.git
synced 2026-11-12 11:48:29 +01:00
28 lines
1.7 KiB
Markdown
28 lines
1.7 KiB
Markdown
# The corpus
|
|
|
|
One directory per contract kind:
|
|
|
|
- `round-trip/` — `<name>.json` + `<name>.md`: the markdown `adfToLosslessMarkdown` must emit for
|
|
that document, byte for byte, and that `losslessMarkdownToAdf` must read back to it
|
|
(`docs/decisions.md` §The round-trip is the product). Grouped by what the fixture exercises.
|
|
- `normalization/` — `<name>.md` + `<name>.json`: markdown input, and the document
|
|
`losslessMarkdownToAdf` must build from it, which must in turn emit and read back to itself. The
|
|
markdown is not canonical.
|
|
- `errors/` — `<name>.md`: markdown input that must not convert. A `<name>.error` beside it
|
|
pins which error.
|
|
- `real-payloads/` — `<name>.json`: ADF Atlassian's editor wrote, round-tripped ADF→markdown→ADF.
|
|
No expected markdown.
|
|
- `commonmark-spec/` — the CommonMark suite run against `commonMarkToAdf` by three checks.
|
|
`spec.json` is the suite; `refusals.json` pins each refusing example to its error `code`;
|
|
`exceptions.json` pins each known divergence by `check`, `example`, `kind` and the exact
|
|
`divergence`, with a `reason`. `kind` is `mark-model` (the permanent count divergence from ADF's
|
|
mark-per-node model), `node-model` (a permanent divergence where ADF holds no node for what
|
|
CommonMark renders) or `pending` (a parser gap).
|
|
|
|
JSON is two-space indent, keys sorted, and a document read back must deep-equal the fixture's
|
|
(`docs/decisions.md` §Equality is deep). `spec.json` is the vendored, upstream machine-readable
|
|
suite, byte-exact from [spec.commonmark.org](https://spec.commonmark.org/0.31.2/spec.json)
|
|
(CommonMark 0.31.2, © John MacFarlane,
|
|
[CC-BY-SA-4.0](https://creativecommons.org/licenses/by-sa/4.0/)), and is not re-serialized by the
|
|
corpus gate.
|