269 lines
20 KiB
Markdown
269 lines
20 KiB
Markdown
# Todo
|
||
|
||
The plan. Design questions are settled in `AGENTS.md`; remaining spec detail is settled at its own
|
||
milestone. A done item shrinks to its title here; its full text moves to `todo-history.md`.
|
||
|
||
## Next session
|
||
|
||
Start a session with: `Read AGENTS.md and todo.md, then do what todo.md's "Next session" says.`
|
||
|
||
1. The first unchecked item in shipping order, per AGENTS.md §15 — or, where that item has no
|
||
release, the planning chunk §15 describes.
|
||
2. In flight: 4c has uncommitted work in `.claude/worktrees/scanning-rule-sites` (branch
|
||
`4c-scanning-rule-sites`) and a stray `bench-4c.ts` that does not ship; continue from the diff.
|
||
3. Before stopping, rewrite this section: the in-flight line, and the prompt itself wherever the
|
||
session found it wrong or short.
|
||
|
||
## Milestones
|
||
|
||
Shipping order: 3h, 3i, 3j, 5a, 5b, 5c, 5d, 5 → `0.1.0` (shipped 2026-09-05); 3k, 11, 4, 12, 13, 4b, 4c, 14, 15, 16, 10, 5g → `0.2.0`;
|
||
4d, 5f → `0.2.1`; 6, 7 → `0.3.0`; 9, 17 → TBD; 5e last.
|
||
The numbering is the order the work was planned in, not the order it ships. `0.2.0`'s order is settled
|
||
(the maintainer, 2026-09-13): 11 makes the tables 4 generates from answer to Atlassian's schema, 4
|
||
proves 12, 13 spells 11's gaps in 12's grammar, and 12 rewrites code 4b and 4c change.
|
||
|
||
- [x] **0 — Scaffold.**
|
||
- [x] **1a — The directive grammar.**
|
||
- [x] **1b — Block node syntaxes.**
|
||
- [x] **1c — Inline node syntaxes and marks.**
|
||
- [x] **1d — Corpus start.**
|
||
- [x] **1d1 — The CommonMark subset.**
|
||
- [x] **1d2 — Block nodes.**
|
||
- [x] **1d3 — Inline nodes and marks.**
|
||
- [x] **2 — `adfToMarkdown`.**
|
||
- [x] **2a — The runner and the CommonMark subset.**
|
||
- [x] **2b — Block nodes.**
|
||
- [x] **2c — Inline nodes and marks.**
|
||
- [x] **2d — The opaque carry.**
|
||
- [x] **2e — Carve-outs and combinations.**
|
||
- [x] **2e1 — The carve-outs and the claimed line.**
|
||
- [x] **2e2 — Mark runs and the runs a carry breaks.**
|
||
- [x] **2e3 — Attribute canonicalization and the quoted value's escape.**
|
||
- [x] **2e4 — The carry's fallback triggers.**
|
||
- [x] **2e5 — Combined documents and the collision property.**
|
||
- [x] **2f — The attributes CommonMark cannot hold.**
|
||
- [x] **3 — `markdownToAdf`.**
|
||
- [x] **3a — The hierarchy.**
|
||
- [x] **3b — The leaf blocks.**
|
||
- [x] **3c — The container blocks.**
|
||
- [x] **3d — Inline text.**
|
||
- [x] **3e — Emphasis and links.**
|
||
- [x] **3f — The directive grammar.**
|
||
- [x] **3g — The node tables read backwards.**
|
||
- [x] **3h — The block nodes.**
|
||
- [x] **3i — The inline nodes and the marks.**
|
||
- [x] **3j — The carry and the combinations.**
|
||
- [x] **3k — The CommonMark spec suite.**
|
||
- [x] **4 — Round-trip property tests.**
|
||
- [x] **4.1 — Editor-normal and the node accessors.**
|
||
- [x] **4.2 — The ADF property.**
|
||
- [x] **4.3 — The markdown property.**
|
||
- [x] **4.4 — The real payloads.**
|
||
- [x] **4b — The block walk's retry (`0.2.0`).**
|
||
- [ ] **4c — The scanning rule's remaining sites (`0.2.0`).** A trailing-anchored regex re-walks
|
||
its run from every start position, so an interior whitespace run costs quadratic time rather
|
||
than linear — 3h measured 80k spaces inside an ATX heading at 11.3s, and 3ms once the walk
|
||
replaced the regex. Three sites the same sweep did not reach: `normalizeLabel` in
|
||
`link-syntax.ts`, whose shortcut-reference input is `scan.source.slice(...)` rather than the
|
||
999-capped `readLabel` value, and two in `emit/inline-line.ts`. The fix is the one 3h used —
|
||
an index walk, `trimTrailingSpace` where the ends match. A fourth of another shape joins
|
||
them: `readNestedDirective` restarts its depth counter per level, so each parse level
|
||
re-scans the region below it and nested inline directives cost O(depth × content) — 3f's
|
||
cost, which 3i's slot parse doubles rather than changes in class, bounded by the 500-level
|
||
guard. A fifth predates 12c: the list-item walk re-scans the rest of a line once per item
|
||
level — `isThematicBreak` in `containerStart` on an opener line, `isBlankLine` and
|
||
`leadingColumns` in `continuesContainer` on a continuation line, and a blank line
|
||
continues every open item without consuming input; 30000 nested items take 4.4s at 59 KB
|
||
(the stability-reviewer, 2026-09-16). §11's scanning rule is
|
||
the whole argument; the pipeline persona feeds documents nobody typed.
|
||
`readDirectiveContent`'s scan splits into named steps with that fix rather than keeping its
|
||
complexity (the maintainer, 2026-09-16). A sixth 4b leaves behind: the parser asks
|
||
`commonMarkSpelling` at every directive-spelled list it reads, and the answer spells the whole
|
||
subtree below, itself quadratic in the depth left, so nested directive lists cost about the
|
||
cube of their depth — 250 rule-first levels parse in 1.3 s at 16.5 kB, 1.5 MB of that shape
|
||
at 250 levels in 0.6 s — bounded by the depth guard like `readNestedDirective` (the
|
||
maintainer, 2026-09-18). A seventh is a throw rather than a cost: `adfDocumentFault` pushes a
|
||
node's content with a spread, so past about 125k sibling nodes the guard throws a
|
||
`RangeError` where §11 owes a `Result` — a loop over the content closes it (the
|
||
stability-reviewer and the maintainer, 2026-09-18).
|
||
- [ ] **4d — What the gate says while it runs (`0.2.1`).** `ci.sh` runs nine legs and announces
|
||
none of them, so five minutes of a Gitea run read as silence and a hang cannot be told from
|
||
a slow pull — the maintainer hit exactly this on the `0.1.0` release. Three causes, each its
|
||
own fix. The legs need markers: `plainpages`' `ci.sh` prints a `step()` header per leg and
|
||
this one prints nothing, so name the leg and the image before each. The longest leg is the
|
||
quietest: `test_output=$(… npm test 2>&1)` buffers the whole Node run to replay it after,
|
||
because the zero-test guard greps the count — stream it and grep a copy (`tee`), rather than
|
||
trading the output for the guard. And two legs are silenced outright, `npm pack` and the
|
||
tarball install, whose `>/dev/null` predates the offline install that made them quick and
|
||
quiet. `publish.sh` owes the same: today it says nothing between reading `private` and the
|
||
registry answering, which is where its `npm ci` and rebuild sit — the seconds §9 accepts
|
||
rather than promoting the gate's `dist`, and unmeasured until the log shows them. Per-leg
|
||
timing is what turns "slow or hung" from a guess into a reading; the browser leg's own
|
||
5.4–7.9s against a 17s warm gate is the number that made it obviously cheap.
|
||
- [x] **5 — Ship `0.1.0`.**
|
||
- [ ] **5e — The publish token's deadline.** `0.1.0` published only once the npm
|
||
token carried **Bypass 2FA**: the account requiring no 2FA on writes was not enough, and npm
|
||
answered `EOTP` until the token itself bypassed. npm retires bypass-2FA tokens for direct
|
||
publishing around January 2027, leaving them `npm stage publish`, which a maintainer
|
||
approves with 2FA; its replacement — trusted publishing over OIDC — supports GitHub-hosted
|
||
Actions, GitLab.com's shared runners and CircleCI's cloud, self-hosted runners planned
|
||
without a date. So the release path has an expiry date and no drop-in successor yet. Revisit:
|
||
whether npm has added Gitea or self-hosted OIDC, and otherwise whether the
|
||
release moves to the staged publish — which fits badly with publish-on-merge,
|
||
and is the trade to weigh rather than discover on a red release run.
|
||
**Settled** (the maintainer, 2026-09-13): last of the known work, clear of `0.2.0`, placed
|
||
there knowing the cutoff may land before `0.2.0` ships.
|
||
- [ ] **5f — Publish the bundle size (`0.2.1`).** Measure the shipped artifact and put the number in the
|
||
README, kept honest by the release pipeline rather than by a human re-reading it. The
|
||
quantity is what a consumer downloads and loads: the tarball `npm pack` produces, its
|
||
unpacked `dist`, and the built JavaScript minified + gzipped — the figure the competitors
|
||
advertise (marklassian's "12kb") and the only apple-to-apple one, since ours ships tsc's
|
||
unminified output and no minifier yet (decide here whether to minify for the build or report
|
||
the unminified gzip). A publish/pipeline leg measures it and fails when the README figure
|
||
drifts, so the number can't rot; the figure lands in README §The package beside the
|
||
"no runtime dependencies" claim. Measured today, unminified: tarball 60.4 kB, unpacked
|
||
221.5 kB, JS gzipped 45.6 kB.
|
||
- [ ] **5g — Reweight the README for the reader (`0.2.0`).** It opens with the pre-launch rationale —
|
||
Atlassian's REST APIs, `pf-editor-service/convert` being decommissioned, a link to
|
||
JRACLOUD-77436 — where a shipped package should answer what it is, what it does and for whom
|
||
first, then the shortest runnable example.
|
||
**Settled** (the maintainer, 2026-09-13): the background goes entirely, no endpoint, ticket or
|
||
"why" note left. The top follows the package-README order: an npm version badge and the Gitea
|
||
Actions badge, a tagline that is also `package.json`'s `description`, a feature list and a
|
||
one-line table of contents, then install and the shortest runnable example; a table of
|
||
everything exported sits near the bottom. The HTML directions are one aside line under the API
|
||
until `0.3.0` ships them, the `// 0.3.0` signatures and the `0.3.0` guarantee going until then.
|
||
The tagline and `description` read "Lossless conversion between Atlassian Document Format and
|
||
extended markdown" until 7 restores HTML.
|
||
- [x] **5a — Rename to `@larvit/adf-codec`.**
|
||
- [x] **5b — The consumer's error surface.**
|
||
- [x] **5b1 — The error's source position.**
|
||
- [x] **5b2 — The error messages.**
|
||
- [x] **5b3 — The code list and the flavour's gaps.**
|
||
- [x] **5b4 — The README's consumer surface.**
|
||
- [x] **5c — The build and the release pipeline.**
|
||
- [x] **5d — The browser leg.**
|
||
- [ ] **6 — The HTML dialect spec (`0.3.0`).** Element-by-element mapping, the `data-*` fidelity
|
||
scheme, the opaque-carry form, and the documented foreign-element set `htmlToAdf` accepts.
|
||
- [ ] **7 — HTML, ship `0.3.0`.** `adfToHtml`, `htmlToAdf`, the composed `markdownToHtml` /
|
||
`htmlToMarkdown`. CommonMark spec suite runs against `markdownToHtml` from here (§10). The
|
||
README's tagline and `package.json`'s `description` regain HTML (5g).
|
||
- [ ] **8 — CLI.** A later goal, shaped around the personas once the library exists.
|
||
- [ ] **9 — The online sandbox.** A web page with two textboxes converting back and forth between ADF and markdown, powered by the library's browser build.
|
||
- [ ] **10 — Lossy conversion (`0.2.0`).** Markdown other tools render readably, to and from ADF,
|
||
keeping the content while dropping what markdown cannot hold — format, design and the richer
|
||
nodes.
|
||
**Settled** (the maintainer, 2026-09-14): two exports composed around the lossless pair, so §1's
|
||
four conversions stay four. `adfToPlainMarkdown(doc)` reduces the document ADF→ADF and hands it
|
||
to `adfToMarkdown`; `plainMarkdownToAdf(markdown)` hands the markdown to `markdownToAdf` and
|
||
lifts the result ADF→ADF. Both carry markdown conventions, so the reduction sits in
|
||
`src/markdown/emit/`, the lift in `src/markdown/parse/` and what both read in `src/markdown/`
|
||
(§11). The markdown is the flavour without directives — CommonMark, the pipe table and `~~` —
|
||
plus the conventions below, chosen for readability from a survey of GitHub, GitLab, Gitea,
|
||
Obsidian, Pandoc, MkDocs, Docusaurus, Typora, Joplin, Logseq, Bear, Notion, Azure DevOps and
|
||
Discord, GitHub's renderer confirming each shape. Writing refuses only what the document guard
|
||
refuses (`not-an-adf-document`, `unsupported-document-version`, `unsupported-nesting-depth`)
|
||
and degrades every other shape; reading refuses what `markdownToAdf` refuses. A lifted node
|
||
carries no `localId`. The lift also reads other tools' spellings — type words in any case,
|
||
Obsidian's aliases, `[X]` — since it reads their output and never writes those spellings.
|
||
- A `panel` is an alert: the marker alone on the quote's first line, a blank `>`, then the body
|
||
(`> [!WARNING]`), in GitHub's five words by colour — info `NOTE`, note `IMPORTANT`, tip and
|
||
success `TIP`, warning `WARNING`, error `CAUTION`, custom `NOTE`. The lift reads those words
|
||
back (`NOTE` info, `IMPORTANT` note, `TIP` tip, `WARNING` warning, `CAUTION` error) and
|
||
Obsidian's by meaning (hint tip; success, check and done success; attention warning; danger,
|
||
failure, fail, missing and bug error; any other word info). Text after a marker in its
|
||
paragraph is the panel's first body paragraph.
|
||
- An `expand` or `nestedExpand` is Obsidian's folded callout, `> [!NOTE]- Title`, a blank `>`,
|
||
then the body. The lift reads a fold sign (`-` or `+`) as an expand whatever the word, the
|
||
rest of the marker's paragraph as its title, and an expand inside an expand as a
|
||
`nestedExpand`.
|
||
- A `taskList` is a bullet list whose items lead with `[x]` or `[ ]` (`- [x] Write the spec`).
|
||
The lift reads a list whose every item is so marked back as a `taskList` — a `blockTaskItem`
|
||
where an item holds more than one block, a nested task list moved beside its item — and
|
||
leaves mixed and ordered lists plain. A `decisionList` is a plain bullet list.
|
||
- `backgroundColor` is `==text==`, and the lift gives `==text==` the Atlassian editor's default
|
||
highlight colour.
|
||
- `layoutSection`/`layoutColumn`, `bodiedExtension`, `bodiedSyncBlock`, `multiBodiedExtension`
|
||
and `extensionFrame` unwrap to their body blocks in order; the CommonMark blocks keep their
|
||
spelling, attributes dropped.
|
||
- `mention` and `status` become their text, the mention's `@` kept; `emoji` its text or else its
|
||
`shortName`; `date` its ISO date in UTC (`2026-09-13`); `inlineCard`, `blockCard` and
|
||
`embedCard` a link to their `url`, dropped when they carry only `data`; a `mediaSingle`
|
||
holding an external image stays ``; `media`, `mediaGroup` and `mediaInline` their
|
||
`alt` text or nothing; `caption` its text as a paragraph; `extension`, `inlineExtension` and
|
||
`syncBlock` their `text` attribute or nothing; `placeholder` nothing; a node no row names, or
|
||
one standing where no spelling holds it, its blocks or its text.
|
||
- A table stays a pipe table: the first row becomes the header, a cell's blocks join on one line
|
||
with spaces, and spans and the cells they cover drop.
|
||
- `code`, `em`, `link`, `strike` and `strong` stay and every other mark drops, keeping its text —
|
||
`subsup` too, since `~2~` is a strike on GitHub; a link no CommonMark escape writes becomes its
|
||
text, and a mark run CommonMark's flanking or matching cannot spell drops its mark.
|
||
- A newline in text becomes a hard break and edge whitespace is trimmed; carriage returns and
|
||
null characters are removed; a paragraph line opening with a code span whose backticks would
|
||
read as a fence loses the code mark; an empty paragraph drops, and adjacent lists of one type
|
||
merge.
|
||
- Rejected in the survey: `~sub~` and `^sup^`, underline and colour spellings, raw HTML
|
||
(`<details>`, `<mark>`), MkDocs `!!!` and the `:::` admonition family, footnotes, definition
|
||
lists, wikilinks, embeds, tags, comments, TOC tokens, spoilers, task states past `[x]`/`[ ]`,
|
||
and lifting bare URLs, `@name`, `:shortcode:` or ISO dates into nodes.
|
||
- [ ] **10a — The reduction.** `adfToPlainMarkdown`'s ADF→ADF reduction, tests first, a test per
|
||
row above.
|
||
- [ ] **10b — The lift.** `plainMarkdownToAdf`'s ADF→ADF lift, tests first, a test per row it reads,
|
||
other tools' spellings included; the editor's default highlight colour looked up and cited.
|
||
- [ ] **10c — The exports.** `adfToPlainMarkdown` and `plainMarkdownToAdf` exported with their README
|
||
sections, and two properties over 4.2's generators: writing refuses only the guard's codes,
|
||
and markdown `adfToPlainMarkdown` wrote reads back through `plainMarkdownToAdf` and writes
|
||
again byte for byte. AGENTS.md §1 records the pair as composed around the lossless one.
|
||
- [x] **11 — Atlassian's ADF schema as the tables' truth.**
|
||
- [x] **11a — The vendored schema.**
|
||
- [x] **11b — The gate.**
|
||
- [x] **12 — The `!adf:` re-spelling.**
|
||
- [x] **12a — The spec and the decision.**
|
||
- [x] **12b — The inline form.**
|
||
- [x] **12c — The block form.**
|
||
- [x] **12d — The README, `MIGRATION.md` and the sweep.**
|
||
- [x] **13 — The schema's gap attributes (`0.2.0`).**
|
||
- [x] **13a — `rule` and `layoutSection`.**
|
||
- [x] **13b — The directive link.**
|
||
- [ ] **14 — The CommonMark subset's directory (`0.2.0`).** `src/markdown/` holds 16 source
|
||
files at its root and 10 adds more there. The CommonMark subset moves under
|
||
`src/markdown/commonmark/` — `backtick-runs.ts`, `commonmark-grammar.ts` as `grammar.ts`,
|
||
`emphasis-matching.ts`, `entity-references.ts` with its test, `link-reference-definitions.ts`
|
||
and `link-syntax.ts` — leaving the flavour's own constructs at the root, the split
|
||
`spec/flavour.md` draws between the subset and the flavour (the systems-architect and the
|
||
maintainer, 2026-09-16).
|
||
- [ ] **15 — The href-less directive link (`0.2.0`).** Refuse `!adf:link[text]` spelling no `href`
|
||
with `unsupported-node-shape` naming the attribute, so the mark has one spelling: today it
|
||
parses to a mark the emitter writes back as a carry, while the schema requires `href` and
|
||
every other directive mark spells without attributes in both directions alike (the
|
||
stability-reviewer, 2026-09-16; the maintainer, 2026-09-17).
|
||
- [ ] **16 — The link wrapping a link (`0.2.0`).** Read `[<http://x/>](/v)` and
|
||
`[!adf:link[a]{href="/u"}](/v)` as `[[a](/u)](/v)` reads — the inner link wins and the outer
|
||
brackets stay literal text, CommonMark's rule that no link holds another — rather than
|
||
dropping the outer link silently as `closeLink`'s `applyMark` does today, with a normalization
|
||
fixture per shape (the stability-reviewer, 2026-09-16; the maintainer, 2026-09-17).
|
||
- [ ] **17 — A machine-enforced size guardrail.** Add a per-function complexity check to the gate —
|
||
branch count or size — so the fits-in-your-head guardrail fails the build rather than
|
||
waiting for a review to catch it (the systems-architect, 2026-09-16); placed after `0.3.0`
|
||
(the maintainer, 2026-09-17).
|
||
|
||
## The ADF inventory to cover
|
||
|
||
From Atlassian's [structure
|
||
reference](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/) — not the
|
||
whole schema: real payloads also carry `taskList`/`taskItem`, `decisionList`/`decisionItem`,
|
||
`layoutSection`/`layoutColumn`, `blockCard`/`embedCard`, `extension`/`bodiedExtension`/`inlineExtension`
|
||
and `placeholder`, none documented there. The documented set is the floor: the floor gets designed
|
||
syntax, the rest rides the opaque carry (§3) until it does too.
|
||
|
||
| | |
|
||
| --- | --- |
|
||
| Top-level block | `blockquote` `bodiedSyncBlock` `bulletList` `codeBlock` `expand` `heading` `mediaGroup` `mediaSingle` `multiBodiedExtension` `orderedList` `panel` `paragraph` `rule` `syncBlock` `table` |
|
||
| Child block | `blockTaskItem` `extensionFrame` `listItem` `media` `nestedExpand` `tableCell` `tableHeader` `tableRow` |
|
||
| Inline | `date` `emoji` `hardBreak` `inlineCard` `mediaInline` `mention` `status` `text` |
|
||
| Marks | `border` `code` `em` `link` `strike` `strong` `subsup` `textColor` `underline` |
|
||
|
||
Plain markdown covers `blockquote`, `bulletList`, `codeBlock`, `heading`, `orderedList`,
|
||
`paragraph`, `rule`, `listItem`, `hardBreak`, `text`, and the `code`, `em`, `link` and `strong`
|
||
marks; `strike` is the flavour's `~~` carve-out. Everything else is what the flavour is for.
|