Skip to content

document(external-scanners): Document Markdown scanner certification #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
odvcencio merged 1 commit into from
Aug 1, 2026
Merged

document(external-scanners): Document Markdown scanner certification #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions content/docs/external-scanners.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,32 @@ remapper: `gotreesitter.AdaptExternalScannerByExternalOrder(sourceLang, targetLa
returning false never mutated the payload — this lets the runtime skip defensive state
snapshots on the hot path.

### Markdown scanner certification matrix

[PR #455](https://github.com/odvcencio/gotreesitter/pull/455) certifies only
the block-level `markdown` scanner. Its
[merge commit `91a5dccc`](https://github.com/odvcencio/gotreesitter/commit/91a5dccc01904dd18d75d7ea84b3a01a67b356c2)
records the proof.

The `markdown` scanner-dependent route records scanner checkpoints. A changed
edit can enter old-tree reuse only for a clean old tree. The normal dirty-span,
fragility, byte-equality, parser-state, and scanner-boundary gates still apply.

The proof compares each incremental tree with a fresh production parse. It
covers insert, delete, and changed-length replace edits at the start, middle,
and end of 8 KiB clean documents. It also requires 25% reused bytes for a
middle replace in a 256 KiB document. It does not promise O(edit) time.

The `markdown_inline` scanner remains uncertified. After the token-invariant
leaf fast path declines, its changed edits use the production full-parse
fallback. The Markdown proof does not apply to `markdown_inline` or
error-bearing old Markdown trees.

| Language | Changed-edit contract |
|---|---|
| `markdown` | Certified checkpointed reuse for clean old trees. |
| `markdown_inline` | Fallback (uncertified) after the leaf fast path declines. |

## Hard-learned behavioral contracts

These four contracts came out of this project's C-parity work. They apply mainly when you
Expand Down
5 changes: 5 additions & 0 deletions scripts/verify-production.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,11 @@ done < <(

curl --silent --fail "$base/" | grep -q 'Certified fresh parsing' || fail "landing route contract missing from /"
curl --silent --fail "$base/docs/performance" | grep -q '5.526× C' || fail "performance geomean (5.526× C) missing from /docs/performance"
external_scanners_html="$(curl --silent --show-error --fail "$base/docs/external-scanners")"
grep -Fq 'Certified checkpointed reuse for clean old trees.' <<<"$external_scanners_html" ||
fail "Markdown clean-tree reuse contract missing from /docs/external-scanners"
grep -Fq 'Fallback (uncertified) after the leaf fast path declines.' <<<"$external_scanners_html" ||
fail "Markdown Inline fallback contract missing from /docs/external-scanners"
curl --silent --show-error --fail --output "$page_body" "$base/changelog"
grep -q 'History you can interrogate' "$page_body" || fail "changelog hero missing from /changelog"
grep -q 'v0.48.0' "$page_body" || fail "v0.48.0 missing from /changelog"
Expand Down
Loading