200 lines
16 KiB
Markdown
200 lines
16 KiB
Markdown
# Todo
|
||
|
||
The plan, in order. Nothing is built. Design questions are settled in `AGENTS.md`; remaining spec
|
||
detail is settled at its own milestone.
|
||
|
||
## Milestones
|
||
|
||
- [x] **0 — Scaffold.** `package.json` per §6, `tsconfig.json`, `.npmrc` (`save-exact=true`), the
|
||
Docker tooling, `renovate.json` (§9), and `.gitea/workflows/ci.yml` gating branches:
|
||
`runs-on: docker-host`, actions pinned to semver tags.
|
||
- [x] **1a — The directive grammar** (`spec/flavour.md`): inline/block/leaf directive forms,
|
||
attributes, escaping, nesting, canonical form, the opaque-carry spelling, the raw-HTML
|
||
input policy.
|
||
- [x] **1b — Block node syntaxes** in `spec/flavour.md`: panel, expand/nestedExpand, the media
|
||
family, the pipe-vs-directive table rule and the directive table form, task and decision
|
||
lists, layout, extensions, syncBlock.
|
||
- [x] **1c — Inline node syntaxes and marks** in `spec/flavour.md`: mention, emoji, status, date,
|
||
inlineCard, mediaInline; underline, subsup, textColor, border; the spelling for text nodes
|
||
whose whitespace CommonMark cannot hold (literal newlines, leading or trailing spaces) —
|
||
escape-based, never literal, since pipe cells trim and pad. At `mediaInline`, check real
|
||
payloads for external-URL support — if it exists, revisit the media section's
|
||
mid-text-image error and its "no slot" ground.
|
||
- [x] **1d — Corpus start** (§10): checked-in fixtures per spec'd node, in `corpus/`, one
|
||
directory per contract kind (`corpus/README.md`).
|
||
**Settled** (the maintainer, 2026-08-26): the nodes CommonMark spells get directive sections
|
||
of their own, rather than riding the opaque carry. Per `@atlaskit/adf-schema` 57.1.0 every
|
||
block node it spells — `blockquote`, `bulletList`, `codeBlock`, `heading`, `listItem`,
|
||
`orderedList`, `paragraph`, `rule` — carries a `localId` with no spelling, `codeBlock` also
|
||
`hideLineNumbers`, `uniqueId` and `wrap`, `blockquote` also marks, and `hardBreak` `text`
|
||
and `localId`; 2f gives each a place, and the plain spelling stays wherever the attributes
|
||
are absent. That hands the two collision sites in `corpus/unspellable/` the second spelling
|
||
they lacked, so each takes the directive form as a `media` with an empty `alt` already does
|
||
(`spec/flavour.md`, the CommonMark image): a `codeBlock` whose info string is empty, and an
|
||
`orderedList` starting at 1.
|
||
**Also blocked**: the link rule covers destination spaces only, so two shapes
|
||
have no spelling and are refused meanwhile — href `https://example.com/a)b` and title
|
||
`He said "hi"`, both in `corpus/unspellable/`. Two defensible spellings each — angle
|
||
brackets or a backslash escape, and for titles `'…'` or `(…)` besides — so §8 leaves
|
||
the pick here. **Also blocked**: block separation is unstated for a CommonMark block beside a
|
||
directive block in a container body — an `expand` whose content is `paragraph` "A" then a
|
||
`panel` (`panelType` `warning`) holding "B" spells `A` and `:::panel warning` either on
|
||
consecutive lines or with a blank line between. Two defensible spellings, so §8 leaves the
|
||
pick here; the answer governs every unknown node type too, the block carry counting as a
|
||
CommonMark block since its spelling is a fenced code block.
|
||
`unspelled-block-separation` refuses the pair meanwhile, an empty paragraph's
|
||
`::paragraph` beside a CommonMark block included — and, since a `mediaSingle`'s spelling now
|
||
follows whether CommonMark can spell its URL, two sibling images differing only by an
|
||
`&` land in the same refusal.
|
||
- [x] **1d1 — The CommonMark subset**: blockquote, bulletList, codeBlock, heading, orderedList,
|
||
paragraph, rule, listItem, hardBreak, text, code spans, and the `code`, `em`, `link`,
|
||
`strike` and `strong` marks — one mark per text node; nesting is 1d3's.
|
||
- [x] **1d2 — Block nodes**: panel, expand/nestedExpand, the media family and the CommonMark
|
||
image shape, both table forms, task and decision lists, layout, extensions, syncBlock —
|
||
with the reserved `marks` attribute and the fence lengths nesting forces.
|
||
- [x] **1d3 — Inline nodes and marks**: date, emoji, inlineCard, mediaInline, mention, status;
|
||
border, subsup, textColor, underline; the content slot's `text` attribute and the
|
||
`:text{text="…"}` whitespace spelling.
|
||
- [ ] **2 — `adfToMarkdown`.** First real code. Each sub-item turns one corpus directory green;
|
||
the two that have no fixtures yet write them in the same chunk, tests first (§10).
|
||
- [x] **2a — The runner and the CommonMark subset.** The corpus runner: walk
|
||
`corpus/round-trip/`, assert `adfToMarkdown` emits each `.md` byte for byte. Decide here
|
||
where §10's coverage check lives, and gate that every `corpus/**/*.json` re-serializes to
|
||
itself under the library's own canonical serializer — one implementation, keys sorted, two
|
||
spellings: two-space indent for the corpus files and the block carry's body, compact for
|
||
the inline carry. `commonmark-subset/` green.
|
||
- [x] **2b — Block nodes.** `block-nodes/` green. A nested list that cannot interrupt the block
|
||
above it is refused meanwhile, not spelled: the maintainer's answer on tight-versus-blank
|
||
separation turns that refusal into an emission. Block separation becomes
|
||
`separationBetween(previous, next, container)` here — a boolean cannot hold the third case
|
||
`spec/flavour.md` states for two directive blocks in a container body, and the maintainer's
|
||
answer on a CommonMark block beside a directive block (1d) drops into the same seam. Give
|
||
the emitter's refusals a corpus home while the directories grow: `corpus/unspellable/`,
|
||
a `.json` beside the `ConvertErrorCode` it must return, the emitter half of `corpus/errors/`.
|
||
- [x] **2c — Inline nodes and marks.** `inline-nodes/` green. `InlineSegment` splits into its
|
||
two axes — escapability (`attribute` for `:text{text="…"}`, `backslash`, `bracketed`,
|
||
`none`) and the emphasis role. A lone surrogate in a text node emits verbatim and becomes
|
||
U+FFFD on any UTF-8 encode, a §2 break plain text still holds open — attribute values
|
||
already escape it. The pipe form's fallback reads the emitted segments rather than naming
|
||
the nodes whose attribute values spell a pipe as syntax, so 2e's `\u007c` narrows it in
|
||
one place.
|
||
- [x] **2d — The opaque carry** (§3). Fixtures and emitter together, into
|
||
`corpus/round-trip/opaque-carry/`: an unknown node in both positions, the reserved `adf`
|
||
info string, and the `codeBlock` whose language is `adf` — carried whole ahead of the
|
||
attribute fallback 2e owes, since the reservation leaves that node no other spelling
|
||
whatever 1d decides for its `localId`.
|
||
- [ ] **2e — Carve-outs and combinations.** Fixtures and emitter together, into
|
||
`corpus/round-trip/combinations/` — the documents that cross what 2a–2d isolated.
|
||
- [ ] **2e1 — The carve-outs and the claimed line.** The directory opens: the three carve-outs
|
||
and their escapes, and a paragraph line inside a container body shaped like a closing
|
||
fence (`:::`, `::: x`). Guard `fenceNestingFault`'s bare-run pop here too — a run shorter
|
||
than the open fence is a fault, not a close — which today's emitter cannot reach.
|
||
- [ ] **2e2 — Mark runs and the runs a carry breaks.** The longest-run rule, attributes
|
||
included, and a mark spelling that cannot open where it sits (`un**-real**istic`; the spec
|
||
owes the carry a trigger). One mark vocabulary lands here, before 2e3 changes the
|
||
attribute spelling: `emphasisSpellings`, `linkAttributes` and the `code`/`link` names join
|
||
`inline-directives.ts`, which holds four of the nine marks while the rest are branch
|
||
literals in the emitter — and the parser (3) needs every name to make `:em[x]` the named
|
||
error `spec/flavour.md` promises.
|
||
- [ ] **2e3 — Attribute canonicalization and the quoted value's escape.** Attribute
|
||
canonicalization, a pipe cell's whitespace edges, and `\u007c` for a `|` inside a quoted
|
||
attribute value. The rule is wider than the pipe: a quoted value spells `` ` ``, `&` and
|
||
`<` raw today, so a backtick pair in an `inlineCard`'s `data`, a `status`'s `style` or the
|
||
inline carry's `json` reads back as a code span, an entity or raw HTML inside the value.
|
||
One escape settles all four, and the pick decides whether a directive or a code span wins
|
||
where they overlap (3). `escaping: 'attribute'` earns its keep at that rule or collapses
|
||
into `none`: nothing the escaper does tells the two apart today, since a carried segment
|
||
holds only spaces, tabs and newlines.
|
||
- [ ] **2e4 — The carry's fallback triggers.** `spec/flavour.md` carries a node its section
|
||
cannot spell — an attrs key no section lists, a value that is not the section's type, an
|
||
arg slot holding no bare token, marks no nesting spells — where the emitter still refuses,
|
||
which leaves the refusals a container's own spelling owns. The carry spells
|
||
`escaping: 'none'`, which is what makes `tryPipeCell` refuse the pipe form for a carry
|
||
whose JSON holds a pipe.
|
||
- [ ] **2e5 — Combined documents and the collision property.** Documents combining nodes rather
|
||
than isolating one, and the gate's collision property: no two corpus documents may emit
|
||
the same bytes — one spelling for two documents is a round-trip break no parser can undo,
|
||
and it is provable without one. It also settles the emitter's one known approximation:
|
||
delimiter flanking is exact, but CommonMark's *matching* — the multiple-of-3 rule and the
|
||
way a run splits across several openers — is not modelled. No reachable violation has been
|
||
found by hand; the property test is what decides it.
|
||
- [ ] **2f — The attributes CommonMark cannot hold.** 1d's settled answer: the block nodes
|
||
CommonMark spells — `blockquote`, `bulletList`, `codeBlock`, `heading`, `listItem`,
|
||
`orderedList`, `paragraph`, `rule` — get directive sections in `spec/flavour.md` carrying
|
||
`localId`, `codeBlock`'s `hideLineNumbers`, `uniqueId` and `wrap`, and `blockquote`'s
|
||
marks, while `hardBreak`'s `text` and `localId` join the inline directive it already has.
|
||
The plain spelling stays wherever those attributes are absent, so only a node that carries
|
||
one takes the directive form — which is what keeps a real payload readable rather than a
|
||
page of carried JSON. Fixtures and emitter together, and the three documents the answer
|
||
settles leave `corpus/unspellable/` as round-trip pairs: `block-local-id`,
|
||
`code-block-empty-language`, `ordered-list-start-one`.
|
||
- [ ] **3 — `markdownToAdf`.** The CommonMark parser is the largest single component; split it
|
||
into sub-items before starting (§15). Fixtures land with the code that reads them:
|
||
`corpus/normalization/` (setext, indented code, loose lists, `*`/`+` bullets, entity
|
||
references, soft wraps — one-way, the markdown not canonical) and `corpus/errors/` (a
|
||
markdown input per named error — malformed directives, the image gap, a claimed pipe-table
|
||
line that does not parse, the content slot, raw HTML with no mapping — each with the error
|
||
it must return). The raw-HTML element mapping is empty until milestone 6, so at `0.1.0`
|
||
every raw-HTML construct in input is an error result. The CommonMark spec suite runs
|
||
against it from here (§10). The parser owes `~` the same `can_open`/`can_close` the emitter
|
||
assumes — CommonMark flanking, as for `*` — which `spec/flavour.md` does not yet pin, and
|
||
the precedence between a directive and the constructs a raw attribute value opens inside it —
|
||
a code span, an entity, raw HTML — which one directive alone already reaches until 2e's
|
||
escape lands.
|
||
`src/` gets its hierarchy at the same split — `adf/`,
|
||
`markdown/`, `html/`, the grammar module shared inside `markdown/` — while the rename is
|
||
still mechanical. Three files do not move whole: `block-directives.ts` and
|
||
`inline-directives.ts` each hold a node table milestones 6-7 need in `adf/` beside a
|
||
markdown spelling that belongs in `markdown/`, and `directive-attributes.ts` fuses the
|
||
format-neutral conformance walk (`vocabularyPairs`) with the markdown value spelling HTML
|
||
has no use for. `spellDestination`, `spellTitle` and `balanced` leave `markdown-inline.ts`
|
||
here too — CommonMark destination spelling `emitLink` and `tryImageLine` share, and the six
|
||
concerns that file carries are one fewer for it. `AttributeKind` and `AttributeVocabulary`
|
||
stay above all of it — the vocabulary a string-typed attribute grammar needs, which is why
|
||
HTML will want them too, not a markdown spelling. Both node tables are a second copy of
|
||
`spec/flavour.md`'s prose with no drift guard, and a mistyped attribute name degrades into a
|
||
false refusal no test catches.
|
||
- [ ] **4 — Round-trip property tests** over the corpus, both ways — the thing that proves 2 and
|
||
3. Editor-normal (§2) gets its implementation here — `toEditorNormal(doc)` and the equality
|
||
the round-trip asserts, which over normalized input is the canonical serializer's compact
|
||
spelling — rather than staying spelled inline as `?? []` at every reader. The reading half is
|
||
`nodeContent`/`nodeAttrs`/`nodeMarks` over the ~28 sites spelling it inline today, which also
|
||
lifts the branch floor §10 keeps below 100 for exactly those halves.
|
||
Generators emit editor-normal ADF (§2). Real sanitized ADF from live Atlassian APIs lands
|
||
here too (§10), in `corpus/real-payloads/`: an ADF→markdown→ADF check with no expected
|
||
markdown, the payloads supplied by the maintainer.
|
||
- [ ] **5 — Release pipeline, ship `0.1.0`.** Publish-on-version-change (§9), `NPM_TOKEN` secret,
|
||
the repo made public first (§6). The `ConvertErrorCode` freeze (§8) is checkable here: every
|
||
`corpus/unspellable/` document is one of 1d's decisions, so the directory empties as they land
|
||
and whatever survives is permanent. `0.1.0` is the markdown round-trip: both markdown
|
||
directions, the types, `isAdfDocument`. The build lands here: a build tsconfig emitting JS
|
||
and `.d.ts` to `dist/` (the dev config's `allowImportingTsExtensions` forces `noEmit`, so
|
||
the build config needs `rewriteRelativeImportExtensions`), plus `exports`/`files` in
|
||
`package.json`. The maintainer's bump PR also removes `private: true`, the guard against any
|
||
earlier publish.
|
||
- [ ] **6 — The HTML dialect spec.** Element-by-element mapping, the `data-*` fidelity scheme, the
|
||
opaque-carry form, and the documented foreign-element set `htmlToAdf` accepts.
|
||
- [ ] **7 — HTML, ship `0.2.0`.** `adfToHtml`, `htmlToAdf`, the composed `markdownToHtml` /
|
||
`htmlToMarkdown`. CommonMark spec suite runs against `markdownToHtml` from here (§10).
|
||
- [ ] **8 — CLI.** A later goal, shaped around the personas once the library exists.
|
||
|
||
## 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.
|